@hcl-software/dxclient 221.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (486) hide show
  1. package/LICENSE +62 -0
  2. package/README.txt +3143 -0
  3. package/bin/dxclient +3 -0
  4. package/dist/LICENSE +62 -0
  5. package/dist/configuration/config.json +52 -0
  6. package/dist/configuration/versionConfigMap.json +34 -0
  7. package/dist/package.json +149 -0
  8. package/dist/packages/admintasks/package-lock.json +21843 -0
  9. package/dist/packages/admintasks/package.json +56 -0
  10. package/dist/packages/admintasks/src/commands/createCredentialVault.d.ts +5 -0
  11. package/dist/packages/admintasks/src/commands/createCredentialVault.js +100 -0
  12. package/dist/packages/admintasks/src/commands/createCredentialVault.js.map +1 -0
  13. package/dist/packages/admintasks/src/commands/createSyndicationRelation.d.ts +4 -0
  14. package/dist/packages/admintasks/src/commands/createSyndicationRelation.js +70 -0
  15. package/dist/packages/admintasks/src/commands/createSyndicationRelation.js.map +1 -0
  16. package/dist/packages/admintasks/src/commands/createVirtualPortal.d.ts +4 -0
  17. package/dist/packages/admintasks/src/commands/createVirtualPortal.js +63 -0
  18. package/dist/packages/admintasks/src/commands/createVirtualPortal.js.map +1 -0
  19. package/dist/packages/admintasks/src/commands/differentialReport.d.ts +6 -0
  20. package/dist/packages/admintasks/src/commands/differentialReport.js +149 -0
  21. package/dist/packages/admintasks/src/commands/differentialReport.js.map +1 -0
  22. package/dist/packages/admintasks/src/commands/exportVirtualPortal.d.ts +4 -0
  23. package/dist/packages/admintasks/src/commands/exportVirtualPortal.js +66 -0
  24. package/dist/packages/admintasks/src/commands/exportVirtualPortal.js.map +1 -0
  25. package/dist/packages/admintasks/src/commands/exportWCMLibrary.d.ts +4 -0
  26. package/dist/packages/admintasks/src/commands/exportWCMLibrary.js +141 -0
  27. package/dist/packages/admintasks/src/commands/exportWCMLibrary.js.map +1 -0
  28. package/dist/packages/admintasks/src/commands/importVirtualPortal.d.ts +4 -0
  29. package/dist/packages/admintasks/src/commands/importVirtualPortal.js +67 -0
  30. package/dist/packages/admintasks/src/commands/importVirtualPortal.js.map +1 -0
  31. package/dist/packages/admintasks/src/commands/importWCMLibrary.d.ts +4 -0
  32. package/dist/packages/admintasks/src/commands/importWCMLibrary.js +112 -0
  33. package/dist/packages/admintasks/src/commands/importWCMLibrary.js.map +1 -0
  34. package/dist/packages/admintasks/src/commands/listVirtualPortals.d.ts +4 -0
  35. package/dist/packages/admintasks/src/commands/listVirtualPortals.js +57 -0
  36. package/dist/packages/admintasks/src/commands/listVirtualPortals.js.map +1 -0
  37. package/dist/packages/admintasks/src/commands/pznRulesExport.d.ts +4 -0
  38. package/dist/packages/admintasks/src/commands/pznRulesExport.js +85 -0
  39. package/dist/packages/admintasks/src/commands/pznRulesExport.js.map +1 -0
  40. package/dist/packages/admintasks/src/commands/pznRulesImport.d.ts +4 -0
  41. package/dist/packages/admintasks/src/commands/pznRulesImport.js +130 -0
  42. package/dist/packages/admintasks/src/commands/pznRulesImport.js.map +1 -0
  43. package/dist/packages/admintasks/src/commands/resEnvProviderActions.d.ts +4 -0
  44. package/dist/packages/admintasks/src/commands/resEnvProviderActions.js +179 -0
  45. package/dist/packages/admintasks/src/commands/resEnvProviderActions.js.map +1 -0
  46. package/dist/packages/admintasks/src/commands/restartCorePods.d.ts +4 -0
  47. package/dist/packages/admintasks/src/commands/restartCorePods.js +45 -0
  48. package/dist/packages/admintasks/src/commands/restartCorePods.js.map +1 -0
  49. package/dist/packages/admintasks/src/commands/restartDXCore.d.ts +4 -0
  50. package/dist/packages/admintasks/src/commands/restartDXCore.js +68 -0
  51. package/dist/packages/admintasks/src/commands/restartDXCore.js.map +1 -0
  52. package/dist/packages/admintasks/src/errors/CommandLineMessages_en.json +62 -0
  53. package/dist/packages/admintasks/src/messages/messages_en.json +34 -0
  54. package/dist/packages/admintasks/src/services/createSyndicationRelationServices.d.ts +4 -0
  55. package/dist/packages/admintasks/src/services/createSyndicationRelationServices.js +53 -0
  56. package/dist/packages/admintasks/src/services/createSyndicationRelationServices.js.map +1 -0
  57. package/dist/packages/admintasks/src/services/differentialReportService.d.ts +5 -0
  58. package/dist/packages/admintasks/src/services/differentialReportService.js +59 -0
  59. package/dist/packages/admintasks/src/services/differentialReportService.js.map +1 -0
  60. package/dist/packages/admintasks/src/services/resEnvProviderService.d.ts +9 -0
  61. package/dist/packages/admintasks/src/services/resEnvProviderService.js +238 -0
  62. package/dist/packages/admintasks/src/services/resEnvProviderService.js.map +1 -0
  63. package/dist/packages/admintasks/src/services/restartCorePodsService.d.ts +4 -0
  64. package/dist/packages/admintasks/src/services/restartCorePodsService.js +45 -0
  65. package/dist/packages/admintasks/src/services/restartCorePodsService.js.map +1 -0
  66. package/dist/packages/admintasks/src/services/restartDXCoreService.d.ts +4 -0
  67. package/dist/packages/admintasks/src/services/restartDXCoreService.js +82 -0
  68. package/dist/packages/admintasks/src/services/restartDXCoreService.js.map +1 -0
  69. package/dist/packages/admintasks/src/services/virtualPortalServices.d.ts +33 -0
  70. package/dist/packages/admintasks/src/services/virtualPortalServices.js +169 -0
  71. package/dist/packages/admintasks/src/services/virtualPortalServices.js.map +1 -0
  72. package/dist/packages/admintasks/src/utils/createCredentialVault.xml +14 -0
  73. package/dist/packages/admintasks/src/utils/differential-report-utils.d.ts +11 -0
  74. package/dist/packages/admintasks/src/utils/differential-report-utils.js +1564 -0
  75. package/dist/packages/admintasks/src/utils/differential-report-utils.js.map +1 -0
  76. package/dist/packages/admintasks/src/utils/differential-report-utils.ts +1651 -0
  77. package/dist/packages/admintasks/src/utils/reportAttributes.properties +179 -0
  78. package/dist/packages/dam/package-lock.json +14605 -0
  79. package/dist/packages/dam/package.json +57 -0
  80. package/dist/packages/dam/src/commands/createSecrets.d.ts +4 -0
  81. package/dist/packages/dam/src/commands/createSecrets.js +61 -0
  82. package/dist/packages/dam/src/commands/createSecrets.js.map +1 -0
  83. package/dist/packages/dam/src/commands/deleteDAMStagingMismatch.d.ts +7 -0
  84. package/dist/packages/dam/src/commands/deleteDAMStagingMismatch.js +50 -0
  85. package/dist/packages/dam/src/commands/deleteDAMStagingMismatch.js.map +1 -0
  86. package/dist/packages/dam/src/commands/deleteSchema.d.ts +4 -0
  87. package/dist/packages/dam/src/commands/deleteSchema.js +80 -0
  88. package/dist/packages/dam/src/commands/deleteSchema.js.map +1 -0
  89. package/dist/packages/dam/src/commands/exportAssets.d.ts +5 -0
  90. package/dist/packages/dam/src/commands/exportAssets.js +106 -0
  91. package/dist/packages/dam/src/commands/exportAssets.js.map +1 -0
  92. package/dist/packages/dam/src/commands/findDAMStagingMismatch.d.ts +7 -0
  93. package/dist/packages/dam/src/commands/findDAMStagingMismatch.js +53 -0
  94. package/dist/packages/dam/src/commands/findDAMStagingMismatch.js.map +1 -0
  95. package/dist/packages/dam/src/commands/importAssets.d.ts +4 -0
  96. package/dist/packages/dam/src/commands/importAssets.js +78 -0
  97. package/dist/packages/dam/src/commands/importAssets.js.map +1 -0
  98. package/dist/packages/dam/src/commands/listSchema.d.ts +4 -0
  99. package/dist/packages/dam/src/commands/listSchema.js +44 -0
  100. package/dist/packages/dam/src/commands/listSchema.js.map +1 -0
  101. package/dist/packages/dam/src/commands/stagingMismatchReport.d.ts +15 -0
  102. package/dist/packages/dam/src/commands/stagingMismatchReport.js +168 -0
  103. package/dist/packages/dam/src/commands/stagingMismatchReport.js.map +1 -0
  104. package/dist/packages/dam/src/commands/stagingResync.d.ts +7 -0
  105. package/dist/packages/dam/src/commands/stagingResync.js +53 -0
  106. package/dist/packages/dam/src/commands/stagingResync.js.map +1 -0
  107. package/dist/packages/dam/src/commands/subscriberDeRegistration.d.ts +4 -0
  108. package/dist/packages/dam/src/commands/subscriberDeRegistration.js +45 -0
  109. package/dist/packages/dam/src/commands/subscriberDeRegistration.js.map +1 -0
  110. package/dist/packages/dam/src/commands/subscriberDetails.d.ts +9 -0
  111. package/dist/packages/dam/src/commands/subscriberDetails.js +50 -0
  112. package/dist/packages/dam/src/commands/subscriberDetails.js.map +1 -0
  113. package/dist/packages/dam/src/commands/subscriberRegistration.d.ts +9 -0
  114. package/dist/packages/dam/src/commands/subscriberRegistration.js +62 -0
  115. package/dist/packages/dam/src/commands/subscriberRegistration.js.map +1 -0
  116. package/dist/packages/dam/src/commands/triggerDAMStaging.d.ts +4 -0
  117. package/dist/packages/dam/src/commands/triggerDAMStaging.js +45 -0
  118. package/dist/packages/dam/src/commands/triggerDAMStaging.js.map +1 -0
  119. package/dist/packages/dam/src/commands/triggerDamReindexing.d.ts +4 -0
  120. package/dist/packages/dam/src/commands/triggerDamReindexing.js +54 -0
  121. package/dist/packages/dam/src/commands/triggerDamReindexing.js.map +1 -0
  122. package/dist/packages/dam/src/commands/updateSecrets.d.ts +4 -0
  123. package/dist/packages/dam/src/commands/updateSecrets.js +61 -0
  124. package/dist/packages/dam/src/commands/updateSecrets.js.map +1 -0
  125. package/dist/packages/dam/src/commands/validateAssets.d.ts +4 -0
  126. package/dist/packages/dam/src/commands/validateAssets.js +64 -0
  127. package/dist/packages/dam/src/commands/validateAssets.js.map +1 -0
  128. package/dist/packages/dam/src/errors/CommandLineMessages_en.json +80 -0
  129. package/dist/packages/dam/src/export/collection.d.ts +10 -0
  130. package/dist/packages/dam/src/export/collection.js +291 -0
  131. package/dist/packages/dam/src/export/collection.js.map +1 -0
  132. package/dist/packages/dam/src/export/favorite.d.ts +2 -0
  133. package/dist/packages/dam/src/export/favorite.js +61 -0
  134. package/dist/packages/dam/src/export/favorite.js.map +1 -0
  135. package/dist/packages/dam/src/export/media-item.d.ts +6 -0
  136. package/dist/packages/dam/src/export/media-item.js +193 -0
  137. package/dist/packages/dam/src/export/media-item.js.map +1 -0
  138. package/dist/packages/dam/src/export/media-type-group.d.ts +2 -0
  139. package/dist/packages/dam/src/export/media-type-group.js +43 -0
  140. package/dist/packages/dam/src/export/media-type-group.js.map +1 -0
  141. package/dist/packages/dam/src/export/media-type.d.ts +2 -0
  142. package/dist/packages/dam/src/export/media-type.js +43 -0
  143. package/dist/packages/dam/src/export/media-type.js.map +1 -0
  144. package/dist/packages/dam/src/export/renditions.d.ts +8 -0
  145. package/dist/packages/dam/src/export/renditions.js +255 -0
  146. package/dist/packages/dam/src/export/renditions.js.map +1 -0
  147. package/dist/packages/dam/src/import/collection.d.ts +5 -0
  148. package/dist/packages/dam/src/import/collection.js +148 -0
  149. package/dist/packages/dam/src/import/collection.js.map +1 -0
  150. package/dist/packages/dam/src/import/favorite.d.ts +2 -0
  151. package/dist/packages/dam/src/import/favorite.js +65 -0
  152. package/dist/packages/dam/src/import/favorite.js.map +1 -0
  153. package/dist/packages/dam/src/import/media-items.d.ts +5 -0
  154. package/dist/packages/dam/src/import/media-items.js +182 -0
  155. package/dist/packages/dam/src/import/media-items.js.map +1 -0
  156. package/dist/packages/dam/src/import/media-type-group.d.ts +2 -0
  157. package/dist/packages/dam/src/import/media-type-group.js +68 -0
  158. package/dist/packages/dam/src/import/media-type-group.js.map +1 -0
  159. package/dist/packages/dam/src/import/media-type.d.ts +2 -0
  160. package/dist/packages/dam/src/import/media-type.js +71 -0
  161. package/dist/packages/dam/src/import/media-type.js.map +1 -0
  162. package/dist/packages/dam/src/import/permission.d.ts +5 -0
  163. package/dist/packages/dam/src/import/permission.js +96 -0
  164. package/dist/packages/dam/src/import/permission.js.map +1 -0
  165. package/dist/packages/dam/src/import/renditions.d.ts +9 -0
  166. package/dist/packages/dam/src/import/renditions.js +326 -0
  167. package/dist/packages/dam/src/import/renditions.js.map +1 -0
  168. package/dist/packages/dam/src/messages/messages_en.json +19 -0
  169. package/dist/packages/dam/src/services/authService.d.ts +5 -0
  170. package/dist/packages/dam/src/services/authService.js +55 -0
  171. package/dist/packages/dam/src/services/authService.js.map +1 -0
  172. package/dist/packages/dam/src/services/stagingService.d.ts +37 -0
  173. package/dist/packages/dam/src/services/stagingService.js +440 -0
  174. package/dist/packages/dam/src/services/stagingService.js.map +1 -0
  175. package/dist/packages/dam/src/services/tokenCache.d.ts +8 -0
  176. package/dist/packages/dam/src/services/tokenCache.js +68 -0
  177. package/dist/packages/dam/src/services/tokenCache.js.map +1 -0
  178. package/dist/packages/dam/src/utils/constants.d.ts +70 -0
  179. package/dist/packages/dam/src/utils/constants.js +76 -0
  180. package/dist/packages/dam/src/utils/constants.js.map +1 -0
  181. package/dist/packages/dam/src/utils/interfaces/collection.d.ts +46 -0
  182. package/dist/packages/dam/src/utils/interfaces/collection.js +3 -0
  183. package/dist/packages/dam/src/utils/interfaces/collection.js.map +1 -0
  184. package/dist/packages/dam/src/utils/interfaces/favorite-request.d.ts +6 -0
  185. package/dist/packages/dam/src/utils/interfaces/favorite-request.js +3 -0
  186. package/dist/packages/dam/src/utils/interfaces/favorite-request.js.map +1 -0
  187. package/dist/packages/dam/src/utils/interfaces/media-request.d.ts +54 -0
  188. package/dist/packages/dam/src/utils/interfaces/media-request.js +3 -0
  189. package/dist/packages/dam/src/utils/interfaces/media-request.js.map +1 -0
  190. package/dist/packages/dam/src/utils/interfaces/media-type-group.d.ts +8 -0
  191. package/dist/packages/dam/src/utils/interfaces/media-type-group.js +3 -0
  192. package/dist/packages/dam/src/utils/interfaces/media-type-group.js.map +1 -0
  193. package/dist/packages/dam/src/utils/interfaces/media-type.d.ts +11 -0
  194. package/dist/packages/dam/src/utils/interfaces/media-type.js +3 -0
  195. package/dist/packages/dam/src/utils/interfaces/media-type.js.map +1 -0
  196. package/dist/packages/dam/src/utils/interfaces/media.d.ts +118 -0
  197. package/dist/packages/dam/src/utils/interfaces/media.js +3 -0
  198. package/dist/packages/dam/src/utils/interfaces/media.js.map +1 -0
  199. package/dist/packages/dam/src/utils/service.d.ts +8 -0
  200. package/dist/packages/dam/src/utils/service.js +126 -0
  201. package/dist/packages/dam/src/utils/service.js.map +1 -0
  202. package/dist/packages/dam/src/validation/collection-list-validate.d.ts +2 -0
  203. package/dist/packages/dam/src/validation/collection-list-validate.js +81 -0
  204. package/dist/packages/dam/src/validation/collection-list-validate.js.map +1 -0
  205. package/dist/packages/dam/src/validation/media-list-validate.d.ts +2 -0
  206. package/dist/packages/dam/src/validation/media-list-validate.js +91 -0
  207. package/dist/packages/dam/src/validation/media-list-validate.js.map +1 -0
  208. package/dist/packages/dam/src/validation/media-type-group-validate.d.ts +1 -0
  209. package/dist/packages/dam/src/validation/media-type-group-validate.js +28 -0
  210. package/dist/packages/dam/src/validation/media-type-group-validate.js.map +1 -0
  211. package/dist/packages/dam/src/validation/media-type-validate.d.ts +1 -0
  212. package/dist/packages/dam/src/validation/media-type-validate.js +28 -0
  213. package/dist/packages/dam/src/validation/media-type-validate.js.map +1 -0
  214. package/dist/packages/dam/src/validation/root-validate.d.ts +1 -0
  215. package/dist/packages/dam/src/validation/root-validate.js +42 -0
  216. package/dist/packages/dam/src/validation/root-validate.js.map +1 -0
  217. package/dist/packages/dam/src/validation/validate.rendition.d.ts +1 -0
  218. package/dist/packages/dam/src/validation/validate.rendition.js +69 -0
  219. package/dist/packages/dam/src/validation/validate.rendition.js.map +1 -0
  220. package/dist/packages/dam/src/validation/validate.versions.d.ts +1 -0
  221. package/dist/packages/dam/src/validation/validate.versions.js +67 -0
  222. package/dist/packages/dam/src/validation/validate.versions.js.map +1 -0
  223. package/dist/packages/deployportlet/package-lock.json +20575 -0
  224. package/dist/packages/deployportlet/package.json +51 -0
  225. package/dist/packages/deployportlet/src/commands/deployPortlet.d.ts +4 -0
  226. package/dist/packages/deployportlet/src/commands/deployPortlet.js +99 -0
  227. package/dist/packages/deployportlet/src/commands/deployPortlet.js.map +1 -0
  228. package/dist/packages/deployportlet/src/commands/undeployPortlet.d.ts +4 -0
  229. package/dist/packages/deployportlet/src/commands/undeployPortlet.js +118 -0
  230. package/dist/packages/deployportlet/src/commands/undeployPortlet.js.map +1 -0
  231. package/dist/packages/deployportlet/src/commands/xmlaccess.d.ts +4 -0
  232. package/dist/packages/deployportlet/src/commands/xmlaccess.js +37 -0
  233. package/dist/packages/deployportlet/src/commands/xmlaccess.js.map +1 -0
  234. package/dist/packages/deployportlet/src/errors/CommandLineMessages_en.json +5 -0
  235. package/dist/packages/deployportlet/src/messages/messages_en.json +10 -0
  236. package/dist/packages/deployportlet/src/services/undeployPortletServices.d.ts +4 -0
  237. package/dist/packages/deployportlet/src/services/undeployPortletServices.js +92 -0
  238. package/dist/packages/deployportlet/src/services/undeployPortletServices.js.map +1 -0
  239. package/dist/packages/deployscriptapplication/package-lock.json +20758 -0
  240. package/dist/packages/deployscriptapplication/package.json +48 -0
  241. package/dist/packages/deployscriptapplication/src/commands/list.js +109 -0
  242. package/dist/packages/deployscriptapplication/src/commands/pull.d.ts +6 -0
  243. package/dist/packages/deployscriptapplication/src/commands/pull.js +195 -0
  244. package/dist/packages/deployscriptapplication/src/commands/pull.js.map +1 -0
  245. package/dist/packages/deployscriptapplication/src/commands/push.d.ts +9 -0
  246. package/dist/packages/deployscriptapplication/src/commands/push.js +282 -0
  247. package/dist/packages/deployscriptapplication/src/commands/push.js.map +1 -0
  248. package/dist/packages/deployscriptapplication/src/commands/restoreScriptApplication.d.ts +5 -0
  249. package/dist/packages/deployscriptapplication/src/commands/restoreScriptApplication.js +125 -0
  250. package/dist/packages/deployscriptapplication/src/commands/restoreScriptApplication.js.map +1 -0
  251. package/dist/packages/deployscriptapplication/src/commands/undeployScriptApplication.d.ts +5 -0
  252. package/dist/packages/deployscriptapplication/src/commands/undeployScriptApplication.js +162 -0
  253. package/dist/packages/deployscriptapplication/src/commands/undeployScriptApplication.js.map +1 -0
  254. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages.properties +211 -0
  255. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ar.properties +211 -0
  256. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ca.properties +211 -0
  257. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_cs.properties +211 -0
  258. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_da.properties +211 -0
  259. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_de.properties +211 -0
  260. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_el.properties +211 -0
  261. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_en.json +129 -0
  262. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_en.properties +211 -0
  263. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_es.properties +211 -0
  264. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_fi.properties +211 -0
  265. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_fr.properties +211 -0
  266. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_hr.properties +211 -0
  267. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_hu.properties +211 -0
  268. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_it.properties +212 -0
  269. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_iw.properties +211 -0
  270. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ja.properties +211 -0
  271. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_kk.properties +211 -0
  272. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ko.properties +211 -0
  273. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_nl.properties +211 -0
  274. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_no.properties +211 -0
  275. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_pl.properties +211 -0
  276. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_pt.properties +211 -0
  277. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_pt_BR.properties +211 -0
  278. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ro.properties +211 -0
  279. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_ru.properties +211 -0
  280. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_sk.properties +211 -0
  281. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_sl.properties +211 -0
  282. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_sv.properties +211 -0
  283. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_th.properties +211 -0
  284. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_tr.properties +211 -0
  285. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_uk.properties +211 -0
  286. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_zh.properties +210 -0
  287. package/dist/packages/deployscriptapplication/src/errors/CommandLineMessages_zh_TW.properties +211 -0
  288. package/dist/packages/deployscriptapplication/src/messages/messages.properties +63 -0
  289. package/dist/packages/deployscriptapplication/src/messages/messages_ar.properties +63 -0
  290. package/dist/packages/deployscriptapplication/src/messages/messages_ca.properties +63 -0
  291. package/dist/packages/deployscriptapplication/src/messages/messages_cs.properties +63 -0
  292. package/dist/packages/deployscriptapplication/src/messages/messages_da.properties +63 -0
  293. package/dist/packages/deployscriptapplication/src/messages/messages_de.properties +63 -0
  294. package/dist/packages/deployscriptapplication/src/messages/messages_el.properties +63 -0
  295. package/dist/packages/deployscriptapplication/src/messages/messages_en.json +61 -0
  296. package/dist/packages/deployscriptapplication/src/messages/messages_en.properties +63 -0
  297. package/dist/packages/deployscriptapplication/src/messages/messages_es.properties +63 -0
  298. package/dist/packages/deployscriptapplication/src/messages/messages_fi.properties +63 -0
  299. package/dist/packages/deployscriptapplication/src/messages/messages_fr.properties +63 -0
  300. package/dist/packages/deployscriptapplication/src/messages/messages_hr.properties +63 -0
  301. package/dist/packages/deployscriptapplication/src/messages/messages_hu.properties +63 -0
  302. package/dist/packages/deployscriptapplication/src/messages/messages_it.properties +63 -0
  303. package/dist/packages/deployscriptapplication/src/messages/messages_iw.properties +63 -0
  304. package/dist/packages/deployscriptapplication/src/messages/messages_ja.properties +63 -0
  305. package/dist/packages/deployscriptapplication/src/messages/messages_kk.properties +63 -0
  306. package/dist/packages/deployscriptapplication/src/messages/messages_ko.properties +63 -0
  307. package/dist/packages/deployscriptapplication/src/messages/messages_nl.properties +63 -0
  308. package/dist/packages/deployscriptapplication/src/messages/messages_no.properties +63 -0
  309. package/dist/packages/deployscriptapplication/src/messages/messages_pl.properties +63 -0
  310. package/dist/packages/deployscriptapplication/src/messages/messages_pt.properties +63 -0
  311. package/dist/packages/deployscriptapplication/src/messages/messages_pt_BR.properties +63 -0
  312. package/dist/packages/deployscriptapplication/src/messages/messages_ro.properties +63 -0
  313. package/dist/packages/deployscriptapplication/src/messages/messages_ru.properties +63 -0
  314. package/dist/packages/deployscriptapplication/src/messages/messages_sk.properties +63 -0
  315. package/dist/packages/deployscriptapplication/src/messages/messages_sl.properties +63 -0
  316. package/dist/packages/deployscriptapplication/src/messages/messages_sv.properties +63 -0
  317. package/dist/packages/deployscriptapplication/src/messages/messages_th.properties +63 -0
  318. package/dist/packages/deployscriptapplication/src/messages/messages_tr.properties +63 -0
  319. package/dist/packages/deployscriptapplication/src/messages/messages_uk.properties +63 -0
  320. package/dist/packages/deployscriptapplication/src/messages/messages_zh.properties +67 -0
  321. package/dist/packages/deployscriptapplication/src/messages/messages_zh_TW.properties +67 -0
  322. package/dist/packages/deployscriptapplication/src/util/constants.d.ts +74 -0
  323. package/dist/packages/deployscriptapplication/src/util/constants.js +98 -0
  324. package/dist/packages/deployscriptapplication/src/util/constants.js.map +1 -0
  325. package/dist/packages/deployscriptapplication/src/util/generic.d.ts +2 -0
  326. package/dist/packages/deployscriptapplication/src/util/generic.js +29 -0
  327. package/dist/packages/deployscriptapplication/src/util/generic.js.map +1 -0
  328. package/dist/packages/deploytheme/package-lock.json +21204 -0
  329. package/dist/packages/deploytheme/package.json +56 -0
  330. package/dist/packages/deploytheme/src/commands/deployApplication.d.ts +4 -0
  331. package/dist/packages/deploytheme/src/commands/deployApplication.js +115 -0
  332. package/dist/packages/deploytheme/src/commands/deployApplication.js.map +1 -0
  333. package/dist/packages/deploytheme/src/commands/deployTheme.d.ts +7 -0
  334. package/dist/packages/deploytheme/src/commands/deployTheme.js +286 -0
  335. package/dist/packages/deploytheme/src/commands/deployTheme.js.map +1 -0
  336. package/dist/packages/deploytheme/src/commands/undeployApplication.d.ts +4 -0
  337. package/dist/packages/deploytheme/src/commands/undeployApplication.js +46 -0
  338. package/dist/packages/deploytheme/src/commands/undeployApplication.js.map +1 -0
  339. package/dist/packages/deploytheme/src/commands/undeployTheme.d.ts +10 -0
  340. package/dist/packages/deploytheme/src/commands/undeployTheme.js +288 -0
  341. package/dist/packages/deploytheme/src/commands/undeployTheme.js.map +1 -0
  342. package/dist/packages/deploytheme/src/errors/CommandLineMessages_en.json +28 -0
  343. package/dist/packages/deploytheme/src/messages/messages_en.json +30 -0
  344. package/dist/packages/deploytheme/src/services/themeServices.d.ts +15 -0
  345. package/dist/packages/deploytheme/src/services/themeServices.js +413 -0
  346. package/dist/packages/deploytheme/src/services/themeServices.js.map +1 -0
  347. package/dist/packages/deploytheme/src/utils/Export.xml +28 -0
  348. package/dist/packages/livesync/package-lock.json +9737 -0
  349. package/dist/packages/livesync/package.json +49 -0
  350. package/dist/packages/livesync/src/commands/pullTheme.d.ts +5 -0
  351. package/dist/packages/livesync/src/commands/pullTheme.js +104 -0
  352. package/dist/packages/livesync/src/commands/pullTheme.js.map +1 -0
  353. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.d.ts +18 -0
  354. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.js +193 -0
  355. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.js.map +1 -0
  356. package/dist/packages/livesync/src/commands/pushTheme.d.ts +12 -0
  357. package/dist/packages/livesync/src/commands/pushTheme.js +233 -0
  358. package/dist/packages/livesync/src/commands/pushTheme.js.map +1 -0
  359. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.d.ts +4 -0
  360. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.js +23 -0
  361. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.js.map +1 -0
  362. package/dist/packages/livesync/src/errors/CommandLineMessages_en.json +52 -0
  363. package/dist/packages/livesync/src/messages/messages_en.json +33 -0
  364. package/dist/packages/livesync/src/services/EventsQueue.d.ts +12 -0
  365. package/dist/packages/livesync/src/services/EventsQueue.js +66 -0
  366. package/dist/packages/livesync/src/services/EventsQueue.js.map +1 -0
  367. package/dist/packages/livesync/src/services/foldersWcmServices.d.ts +7 -0
  368. package/dist/packages/livesync/src/services/foldersWcmServices.js +120 -0
  369. package/dist/packages/livesync/src/services/foldersWcmServices.js.map +1 -0
  370. package/dist/packages/livesync/src/services/htmlComponentWcmServices.d.ts +6 -0
  371. package/dist/packages/livesync/src/services/htmlComponentWcmServices.js +108 -0
  372. package/dist/packages/livesync/src/services/htmlComponentWcmServices.js.map +1 -0
  373. package/dist/packages/livesync/src/services/initialSyncServices.d.ts +3 -0
  374. package/dist/packages/livesync/src/services/initialSyncServices.js +94 -0
  375. package/dist/packages/livesync/src/services/initialSyncServices.js.map +1 -0
  376. package/dist/packages/livesync/src/services/livesyncUtils.d.ts +2 -0
  377. package/dist/packages/livesync/src/services/livesyncUtils.js +59 -0
  378. package/dist/packages/livesync/src/services/livesyncUtils.js.map +1 -0
  379. package/dist/packages/livesync/src/services/metadataServices.d.ts +16 -0
  380. package/dist/packages/livesync/src/services/metadataServices.js +117 -0
  381. package/dist/packages/livesync/src/services/metadataServices.js.map +1 -0
  382. package/dist/packages/livesync/src/services/ongoingSyncServices.d.ts +10 -0
  383. package/dist/packages/livesync/src/services/ongoingSyncServices.js +266 -0
  384. package/dist/packages/livesync/src/services/ongoingSyncServices.js.map +1 -0
  385. package/dist/packages/livesync/src/services/wcmRestV2Services.d.ts +5 -0
  386. package/dist/packages/livesync/src/services/wcmRestV2Services.js +92 -0
  387. package/dist/packages/livesync/src/services/wcmRestV2Services.js.map +1 -0
  388. package/dist/packages/livesync/src/types/EventHandler.type.d.ts +5 -0
  389. package/dist/packages/livesync/src/types/EventHandler.type.js +3 -0
  390. package/dist/packages/livesync/src/types/EventHandler.type.js.map +1 -0
  391. package/dist/packages/livesync/src/types/EventQueueItem.type.d.ts +7 -0
  392. package/dist/packages/livesync/src/types/EventQueueItem.type.js +3 -0
  393. package/dist/packages/livesync/src/types/EventQueueItem.type.js.map +1 -0
  394. package/dist/packages/livesync/src/types/OngoingSyncHooks.type.d.ts +4 -0
  395. package/dist/packages/livesync/src/types/OngoingSyncHooks.type.js +3 -0
  396. package/dist/packages/livesync/src/types/OngoingSyncHooks.type.js.map +1 -0
  397. package/dist/packages/livesync/src/types/WcmRestApiV2.type.d.ts +99 -0
  398. package/dist/packages/livesync/src/types/WcmRestApiV2.type.js +3 -0
  399. package/dist/packages/livesync/src/types/WcmRestApiV2.type.js.map +1 -0
  400. package/dist/packages/livesync/src/types/index.d.ts +4 -0
  401. package/dist/packages/livesync/src/types/index.js +17 -0
  402. package/dist/packages/livesync/src/types/index.js.map +1 -0
  403. package/dist/packages/mls_exim/package-lock.json +13855 -0
  404. package/dist/packages/mls_exim/package.json +51 -0
  405. package/dist/packages/mls_exim/src/errors/CommandLineMessages_en.json +19 -0
  406. package/dist/packages/mls_exim/src/export/mlsExport.d.ts +7 -0
  407. package/dist/packages/mls_exim/src/export/mlsExport.js +292 -0
  408. package/dist/packages/mls_exim/src/export/mlsExport.js.map +1 -0
  409. package/dist/packages/mls_exim/src/export/mlsExport.ts +371 -0
  410. package/dist/packages/mls_exim/src/import/mlsImport.d.ts +8 -0
  411. package/dist/packages/mls_exim/src/import/mlsImport.js +104 -0
  412. package/dist/packages/mls_exim/src/import/mlsImport.js.map +1 -0
  413. package/dist/packages/mls_exim/src/import/mlsImport.ts +138 -0
  414. package/dist/packages/mls_exim/src/messages/messages_en.json +14 -0
  415. package/dist/packages/mls_exim/src/utils/interfaces/export.d.ts +133 -0
  416. package/dist/packages/mls_exim/src/utils/interfaces/export.js +3 -0
  417. package/dist/packages/mls_exim/src/utils/interfaces/export.js.map +1 -0
  418. package/dist/packages/mls_exim/src/utils/interfaces/export.ts +165 -0
  419. package/dist/packages/mls_exim/src/utils/interfaces/import.d.ts +52 -0
  420. package/dist/packages/mls_exim/src/utils/interfaces/import.js +3 -0
  421. package/dist/packages/mls_exim/src/utils/interfaces/import.js.map +1 -0
  422. package/dist/packages/mls_exim/src/utils/interfaces/import.ts +76 -0
  423. package/dist/packages/sharedlibrary/package-lock.json +20575 -0
  424. package/dist/packages/sharedlibrary/package.json +51 -0
  425. package/dist/packages/sharedlibrary/src/commands/delete.d.ts +4 -0
  426. package/dist/packages/sharedlibrary/src/commands/delete.js +64 -0
  427. package/dist/packages/sharedlibrary/src/commands/delete.js.map +1 -0
  428. package/dist/packages/sharedlibrary/src/commands/upload.d.ts +4 -0
  429. package/dist/packages/sharedlibrary/src/commands/upload.js +105 -0
  430. package/dist/packages/sharedlibrary/src/commands/upload.js.map +1 -0
  431. package/dist/packages/sharedlibrary/src/errors/CommandLineMessages_en.json +10 -0
  432. package/dist/packages/sharedlibrary/src/messages/messages_en.json +7 -0
  433. package/dist/packages/sharedlibrary/src/services/sharedLibraryServices.d.ts +5 -0
  434. package/dist/packages/sharedlibrary/src/services/sharedLibraryServices.js +100 -0
  435. package/dist/packages/sharedlibrary/src/services/sharedLibraryServices.js.map +1 -0
  436. package/dist/packages/syndication/package-lock.json +20575 -0
  437. package/dist/packages/syndication/package.json +51 -0
  438. package/dist/packages/syndication/src/commands/subscriber.d.ts +4 -0
  439. package/dist/packages/syndication/src/commands/subscriber.js +62 -0
  440. package/dist/packages/syndication/src/commands/subscriber.js.map +1 -0
  441. package/dist/packages/syndication/src/commands/syndicationReport.d.ts +2 -0
  442. package/dist/packages/syndication/src/commands/syndicationReport.js +99 -0
  443. package/dist/packages/syndication/src/commands/syndicationReport.js.map +1 -0
  444. package/dist/packages/syndication/src/commands/syndicator.d.ts +4 -0
  445. package/dist/packages/syndication/src/commands/syndicator.js +62 -0
  446. package/dist/packages/syndication/src/commands/syndicator.js.map +1 -0
  447. package/dist/packages/syndication/src/commands/syndicatorFailedItem.d.ts +4 -0
  448. package/dist/packages/syndication/src/commands/syndicatorFailedItem.js +104 -0
  449. package/dist/packages/syndication/src/commands/syndicatorFailedItem.js.map +1 -0
  450. package/dist/packages/syndication/src/errors/CommandLineMessages_en.json +12 -0
  451. package/dist/packages/syndication/src/messages/messages_en.json +9 -0
  452. package/dist/packages/syndication/src/services/syndicationService.d.ts +108 -0
  453. package/dist/packages/syndication/src/services/syndicationService.js +167 -0
  454. package/dist/packages/syndication/src/services/syndicationService.js.map +1 -0
  455. package/dist/src/errors/CommandLineMessages_en.json +53 -0
  456. package/dist/src/index.d.ts +1 -0
  457. package/dist/src/index.js +2207 -0
  458. package/dist/src/index.js.map +1 -0
  459. package/dist/src/services/apiServices.d.ts +32 -0
  460. package/dist/src/services/apiServices.js +932 -0
  461. package/dist/src/services/apiServices.js.map +1 -0
  462. package/dist/src/services/filesServices.d.ts +9 -0
  463. package/dist/src/services/filesServices.js +134 -0
  464. package/dist/src/services/filesServices.js.map +1 -0
  465. package/dist/src/services/requestService.d.ts +4 -0
  466. package/dist/src/services/requestService.js +55 -0
  467. package/dist/src/services/requestService.js.map +1 -0
  468. package/dist/src/utils/commands.d.ts +2 -0
  469. package/dist/src/utils/commands.js +13 -0
  470. package/dist/src/utils/commands.js.map +1 -0
  471. package/dist/src/utils/constants.d.ts +389 -0
  472. package/dist/src/utils/constants.js +464 -0
  473. package/dist/src/utils/constants.js.map +1 -0
  474. package/dist/src/utils/interfaces.d.ts +19 -0
  475. package/dist/src/utils/interfaces.js +3 -0
  476. package/dist/src/utils/interfaces.js.map +1 -0
  477. package/dist/src/utils/logger.d.ts +3 -0
  478. package/dist/src/utils/logger.js +126 -0
  479. package/dist/src/utils/logger.js.map +1 -0
  480. package/dist/src/utils/utils.d.ts +31 -0
  481. package/dist/src/utils/utils.js +791 -0
  482. package/dist/src/utils/utils.js.map +1 -0
  483. package/dist/src/utils/validateOptions.d.ts +4 -0
  484. package/dist/src/utils/validateOptions.js +730 -0
  485. package/dist/src/utils/validateOptions.js.map +1 -0
  486. package/package.json +149 -0
package/README.txt ADDED
@@ -0,0 +1,3143 @@
1
+ # DXClient
2
+
3
+ DXClient is a command line tool featuring a single, unified interface to all HCL DX automation and CI/CD-related tasks. It helps developers manage several DX tasks such as uploading one or more portlets, Script Applications, and themes. Administrators can manage WCM libraries, PZN rules, shared libraries, etc.
4
+
5
+ DXClient can take artifacts developed locally and deploy them to HCL DX servers independently of whether these are deployed on-premises platforms in standalone, cluster, or farm-topologies, or in a container environment.
6
+
7
+ DXClient is meant to be the one-stop, platform-independent solution that lets you integrate HCL DX with any automation infrastructure of your choice.
8
+
9
+ DXClient comes with two deployment options:
10
+
11
+ 1. One option is the DXClient container package. DXClient is packaged as a container that can be run using OCI-based runtimes such as Docker or Podman. It is available as a container image with HCL DX 9.5 CF196 and later releases.
12
+
13
+ 2. The alternative deployment option is DXClient as native JavaScript code. Customers who want to rely on this deployment option need to install their own Node.js and NPM runtime environment in the correct version and must install necessary dependencies as needed.
14
+
15
+ **Important Note related to DXClient version & distribution:** DXClient is now available free to download/install through NpmJS and harbor repositories. Following the decision to openly distribute DXClient, we have changed the current versioning format of DXClient from 1.xx.x to <CFNumber>.x.x. For example, the last release version of DXClient was "1.29.0" but the upcoming release is reformatted to "221.0.0". The number 221 is synonymous with the CF Number version of DX deployments.
16
+
17
+ **This document is for the native JS (non-container) version of DXClient**
18
+
19
+ # Requirements
20
+ To use these tools you will need:
21
+ - Node.js must be installed on your workstation. It is tested using the LTS versions of Node.js.
22
+
23
+ Note: You can verify that Node.js is installed by running the following commands:
24
+
25
+ `node -v`
26
+
27
+ # Install DXClient with package from HCL Software Portal
28
+
29
+ Complete the following steps to install the DXClient tool to your local development workstation or automation server.
30
+
31
+ 1. Download the DXClient.zip file (DXClient_VX_XXXXXXXX-XXXX.zip) to a local directory on the local workstation from your HCL Digital Experience 9.5 CF196 or higher entitlements on the HCL Software License Portal.
32
+ 2. run `make install` to install all dependencies
33
+ In case of windows OS run `make_install.bat` to install all dependencies
34
+
35
+ (Optional)Run the below command in case you prefer to link your application to the local npm module in your machine (Refer to the Notes section before you proceed).
36
+
37
+ For Linux and Apple MacOS platforms
38
+ ```
39
+ make link
40
+ ```
41
+
42
+ For Microsoft Windows platforms:
43
+
44
+ ```
45
+ make_link.bat
46
+ ```
47
+
48
+ > ### Notes:
49
+ > Avoid using `make link` command when scripting deployments from an automation server (e.g. in pipelines) as there is a chance of picking up the wrong dependencies during tool version upgrades.
50
+
51
+ 3. Use the command below to run the application.
52
+
53
+ For Linux and Apple MacOS platforms
54
+
55
+ ```
56
+ ./bin/dxclient
57
+ ```
58
+
59
+ For Microsoft Windows platforms:
60
+
61
+ ```
62
+ node bin/dxclient
63
+ ```
64
+
65
+ 4. Run 'dxclient -V' to verify that the dxclient command line is installed.
66
+
67
+ 5. A folder named 'store' will be created in your working directory.
68
+
69
+ 6. You will be able to find the configuration, logger, output, and sample files under location - <working-directory>/store.
70
+ If you require to create a new configuration, set the environment variable `VOLUME_DIR` to the desired directory name and run your task. For example:
71
+
72
+ "Linux and Apple macOS"
73
+
74
+ ```
75
+ bash
76
+ export VOLUME_DIR=storeForScriptApplication
77
+
78
+ # or if you want spaces in its value, enclose it in double quotes ("")
79
+ export VOLUME_DIR="store for script application"
80
+ ```
81
+
82
+ "Microsoft Windows"
83
+
84
+ ```
85
+ batch
86
+ set VOLUME_DIR=storeForScriptApplication
87
+
88
+ :: or if you want spaces in its value
89
+ set VOLUME_DIR=store for script application
90
+ ```
91
+
92
+ !!!important
93
+ Do not enclose the value of `VOLUME_DIR` in double quotes ("") in Windows. This produces errors when executing DXClient commands.
94
+
95
+ 7. The `VOLUME_DIR` requires read and write access permissions. Set appropriate permissions for the `VOLUME_DIR` as per user/group/owner.
96
+
97
+ "Linux and Apple macOS"
98
+
99
+ ```
100
+ bash
101
+ chmod xxx <working-directory>/<VOLUME_DIR>
102
+
103
+ # where xxx is a 3-digit number where each digit can be anything from 0 to 7.
104
+ # Ref: https://wiki.archlinux.org/title/File_permissions_and_attributes#Numeric_method
105
+ ```
106
+
107
+ "Microsoft Windows"
108
+
109
+ ```
110
+ 1. Right click `<working-directory>/<VOLUME_DIR>` directory > "Properties" > "Security" Tab.
111
+ 2. Set the appropriate permission for the folder.
112
+ ```
113
+
114
+ You can find the configuration, logger, and output files under `<working-directory>/<VOLUME_DIR>`.
115
+
116
+ Common command arguments can be pre-configured inside the config.json file available under the `<working-directory>/<VOLUME_DIR>` folder. A sample configuration file that can be used on on-premises platforms in standalone, cluster (default-config.json), or Kubernetes (default-config-kube.json) platforms is also available under <working-directory>/samples/sample-configurations for reference. If you want to override any of the parameters in the config.json, add them in your command line.
117
+
118
+ ## DXClient uninstall
119
+
120
+ To uninstall the DXClient tool, follow the commands below.
121
+
122
+ For Linux and Apple MacOS platforms:
123
+
124
+ ```
125
+ make clean
126
+ ```
127
+
128
+ For Microsoft Windows platforms:
129
+
130
+ ```
131
+ make uninstall.bat
132
+ ```
133
+
134
+ To unlink the DXClient tool, follow the commands below.
135
+
136
+ For Linux and Apple MacOS platforms:
137
+
138
+ ```
139
+ make unlink
140
+ ```
141
+
142
+ For Microsoft Windows platforms:
143
+
144
+ ```
145
+ make_unlink.bat
146
+ ```
147
+
148
+ # Install/Uninstall DXClient from NpmJS registry
149
+
150
+ Use `npm install @hcl-software/dxclient` command to install the latest version of DXClient.
151
+
152
+ Use `npm install -g @hcl-software/dxclient` command to install DXClient globally.
153
+
154
+ Use `npm uninstall @hcl-software/dxclient` command to uninstall.
155
+
156
+ This option to install/uninstall are avaialble from HCL DX 9.5 CF221 deployment. The latest version you install will be "221.0.0".
157
+
158
+ > **Note:**
159
+ > To install dxclient on a Windows OS in an empty folder, first create an empty `package.json` file before running the npm install commands.
160
+
161
+ ## Additional Information
162
+
163
+ 1. The attribute `-dxConnectHostname` has been deprecated (since CF202) and removed (since CF210) and must be replaced with `-hostname` wherever necessary.
164
+ 2. The attribute `-targetServerHostname`, `-targetServerPort`,`-targetServerUsername`,`-targetServerPassword` & `-targetServerProfileName` has been deprecated (since CF202) and removed (since CF210) and must be replaced with `-targetHostname`, `-targetDxConnectPort`,`-targetDxConnectUsername`,`-targetDxConnectPassword` & `-targetDxProfileName` respectively wherever necessary.
165
+ 3. If deploying or importing huge CICD artifacts using DXClient to the Kubernetes environment, you might receive failure or request pending messages while you run the ceratin tasks. This might happen because of the connection getting closed by the load balancer due to timeout before the response is ready. In such situations, before re-triggering the request, we advise you to check your target server to verify if the artifact has been deployed/imported or the server is up, as the request was already triggered from the client-side. In cases of request pending you are expected to receive a `requestId` which you can use to check the status of response later. Find troubleshooting tips [here](troubleshooting_dxclient.md#troubleshooting-for-some-known-issues).
166
+ 4. The maximum input file size allowed in DXClient is 256 MB currently. This limitation will be addressed in one of the future releases.
167
+ 5. As of CF213, the property `DXCONNECT_MAX_MEMORY_SIZE_MB` in DXC_ConfigSettings Resource Environment Provider has been removed. Refer [DXC_ConfigSettings](dxconnect.md#resource-environment-provider-property-for-dxconnect) for more details.
168
+
169
+ ## Verify the DXClient installation
170
+
171
+ Successful installation of the DXClient tool can be checked using the "`dxclient -V`" command which should show the version of the DX Client tool installed.
172
+
173
+ Once installed, commands can be executed using the DXClient tool to perform CI / CD actions on HCL DX 9.5 servers.
174
+
175
+ **Important:**
176
+ The DXClient version is mostly forward and backward compatible with the DX CF versions. However, in some cases, it might not work as expected if the CF versions are different. Make sure that the CF versions of both DXClient and DX Core are the same in your installation.
177
+ You may use "`dxclient version-compat`" to check version compatibility between DX Core and DXClient.
178
+
179
+ ### DXClient Release Timelines & Updates
180
+
181
+ 1. If connecting to an HCL DX 9.5 CF19 deployment, the DXClient tool provides commands supporting the following artifact types along with the documentation -
182
+ * deploy/undeploy portlets
183
+ * deploy script applications
184
+ * xmlaccess
185
+ * restore script application
186
+
187
+ 2. If connecting to an HCL DX 9.5 CF192 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation -
188
+ * undeploy script applications
189
+ * deploy themes (EAR & WebDAV based)
190
+
191
+ 3. If connecting to an HCL DX 9.5 CF193 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation -
192
+ * restart application
193
+ * deploy application
194
+ * manage syndicator
195
+ * manage subscriber
196
+
197
+ 4. If connecting to an HCL DX 9.5 CF195 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
198
+ * undeploy theme
199
+
200
+ 5. If connecting to an HCL DX 9.5 CF196 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
201
+ * shared library
202
+
203
+ 6. If connecting to an HCL DX 9.5 CF197 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
204
+ * Get Syndication failed report
205
+ * Delete DAM schema
206
+
207
+ 7. If connecting to an HCL DX 9.5 CF198 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
208
+ * Resource Environment Provider Updates - Create,update and delete
209
+ * Create/import/export/list of virtual portal
210
+ * Import and Export PZN
211
+ * List DAM schemas
212
+
213
+ 8. If connecting to an HCL DX 9.5 CF199 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
214
+ * Resource Environment Provider Updates - Export and Import
215
+ * Create Credential Vault Slot
216
+ * Create Syndication Relation
217
+ * DAM Staging - Register, Deregister and Trigger
218
+
219
+ 9. If connecting to an HCL DX 9.5 CF200 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
220
+ * WCM Libraries - Export and Import
221
+ * DX Core Configuration Reports - summary-report
222
+
223
+ 10. If connecting to an HCL DX 9.5 CF201 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
224
+ * An optional parameter requestId added to Deploy theme, Deploy application, Restart DX Core server, and Manage virtual portals.
225
+ * Retrieve feature added to the Resource environment provider.
226
+ * Accessing ConfigWizard in container environment
227
+ Note that a few parameters are deprecated and replaced with new parameters in the DX Core configuration reports. For information, see DX Core server configuration report.
228
+
229
+ 11. If connecting to an HCL DX 9.5 CF202 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
230
+ * Deprecated parameter dxConnectHostname. It is recommended that you start using the replacement parameter -hostname starting from CF202 wherever necessary.
231
+ * DAM Assets Export & import
232
+
233
+ 12. If connecting to an HCL DX 9.5 CF207 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
234
+ * Support to set different Container Runtimes.
235
+
236
+ 13. If connecting to an HCL DX 9.5 CF208 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
237
+ * Get all subscribers details for DAM staging
238
+
239
+ 14. If connecting to an HCL DX 9.5 CF209 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation
240
+ * Restart Core Pods in a Kubernetes Deployment
241
+
242
+ 15. If connecting to an HCL DX 9.5 CF210 deployment, following changes are to be expected.
243
+ * Removed paramaters deprecated during CF201 & CF202 deployment.
244
+ * added ability to export/import wcm libraries in Virtual Portal.
245
+
246
+ 16. If connecting to an HCL DX 9.5 CF211 deployment, following changes are to be expected.
247
+ * Deploy and Undeploy Applications
248
+
249
+ 17. If connecting to an HCL DX 9.5 CF213 deployment, following changes are to be expected.
250
+ * Livesync of WebDAV based Themes
251
+
252
+ 18. If connecting to an HCL DX 9.5 CF214 deployment, following changes are to be expected.
253
+ * Livesync Improvements
254
+ - List themes during Pull theme in case themeName is not provided.
255
+ - Livesync is now supported in scaled DX environment setups
256
+
257
+ 19. If connecting to an HCL DX 9.5 CF216 deployment, following changes are to be expected.
258
+ * Show Version compatibility details between DXCore and DXClient
259
+
260
+ 20. If connecting to an HCL DX 9.5 CF219 deployment, following changes are to be expected.
261
+ * Enabled multiple environment configuration in node version
262
+
263
+ 21. If connecting to an HCL DX 9.5 CF221 deployment, following changes are to be expected.
264
+ * DXClient Version Type(Node/Container) information available using help/version-compat commands
265
+ * A one time license agreement click-through is enabled. To skip the prompt, use "accept-license" command.
266
+ * DXClient will be openly distributed in NpmJS & harbor repository.
267
+
268
+ ## DXClient configuration
269
+
270
+ Common command arguments that are listed in `config.json` can be pre-configured via this file. The common arguments could also be provided through command line. If so, it will override the values in `config.json` and execute.
271
+
272
+ A sample configuration file that could be used on-premises platforms in standalone, cluster platforms is also available under `samples/sample-configurations/default-config.json` for reference.
273
+
274
+ ### DXClient Commands
275
+ - `make link`: To create a symlinks to global npm folder for Microsoft Windows platforms
276
+ - `make_link.bat` : To create a symlinks to global npm folder
277
+ - `make unlink`: To remove the symlink created by the make link
278
+ - `make_unlink.bat`: To remove the symlink created by the make link for Microsoft Windows platforms
279
+ - `make install`: To install all dependency
280
+ - `make_install.bat` : To install all dependencies of windows OS
281
+ - `make uninstall`: To uninstall the package and dependency
282
+ - `make_uninstall.bat`: To uninstall the package and dependency of windows OS
283
+
284
+ To list the artifact details, run
285
+
286
+ ```
287
+ dxclient - help document for the commands usage
288
+ dxclient accept-license - command to skip prompt of click-through license acceptance agreement.
289
+ dxclient version-compat - command to show version compatibility details between DX Core and DXClient
290
+ dxclient deploy-portlet [options] - command to execute the deploy portlet action
291
+ dxclient undeploy-portlet [options] - command to execute the undeploy portlet action
292
+ dxclient xmlaccess [options] - command to execute the xmlaccess action
293
+ dxclient deploy-scriptapplication [options] - command to execute the deploy script application action
294
+ dxclient undeploy-scriptapplication [options] - command to execute the undeploy script application action
295
+ dxclient restore-scriptapplication [options] - command to execute the restore script application action
296
+ dxclient deploy-theme [options] - command to execute the deploy theme action
297
+ dxclient undeploy-theme [options] - command to execute the undeploy theme action
298
+ dxclient deploy-application [options] - command to execute the deploy application action
299
+ dxclient undeploy-application [options] - command to execute the undeploy application action
300
+ dxclient manage-syndicator [options] - command to execute the syndicator action
301
+ dxclient manage-subscriber [options] - command to execute the subscriber action
302
+ dxclient restart-dx-core [options] - command to execute the DX Core restart action
303
+ dxclient mls-export [options] - command to export content of a WCM Library for translation
304
+ dxclient mls-import [options] - command to import the translated contents into the DX
305
+ dxclient manage-syndicator get-syndication-report [options] - command to execute the syndication failed report
306
+ dxclient delete-dam-schema [options] - command to execute the delete dam schema action
307
+ dxclient list-dam-schemas [options] - command to execute the list of all dam schema action
308
+ dxclient pzn-export [options] - command to export the pzn rules from the target server
309
+ dxclient pzn-import [options] - command to import the pzn rules into the target server
310
+ dxclient resource-env-provider [options] - command to create, update or delete a custom property from an existing Resource Environment Provider
311
+ dxclient manage-virtual-portal [options] - command to manage virtual portal tasks in the DX server
312
+ dxclient manage-dam-staging register-dam-subscriber [options] - command to execute the register subscriber action
313
+ dxclient manage-dam-staging trigger-staging [options] - command to execute the trigger staging action
314
+ dxclient manage-dam-staging deregister-dam-subscriber [options] - command to execute the deregister subscriber action
315
+ dxclient manage-dam-staging get-all-subscribers [options] - command to execute the get subscribers details action
316
+ dxclient manage-dam-staging update-secrets [options] - command to execute the update secrets action
317
+ dxclient manage-dam-staging find-staging-mismatch [options] - command to execute the find mismatch action
318
+ dxclient manage-dam-staging get-staging-mismatch-report [options] - command to generate staging mismatch report
319
+ dxclient manage-dam-staging start-staging-resync [options] - command to execute the staging resync action
320
+ dxclient manage-dam-staging delete-staging-mismatch [options] - command to execute the delete staging mismatch action
321
+ dxclient create-credential-vault [options] - command to create credential vault in the DX server
322
+ dxclient wcm-library-export [options] - command to export the wcm libraries from the target server
323
+ dxclient wcm-library-import [options] - command to import the wcm libraries from the target server
324
+ dxclient dx-core-configuration-reports [options] - command to generate any dx core configuration reports
325
+ dxclient manage-dam-assets export-assets [options] - command to export the dam assets
326
+ dxclient manage-dam-assets validate-assets [options] - command to validate the dam assets
327
+ dxclient manage-dam-assets import-assets [options] - command to import the dam assets
328
+ dxclient restart-core-pods [options] - command to execute the Restart Core Pods action (for Kubernetes deployments)
329
+ dxclient livesync push-theme [options] - command for watching a theme folder path live and syncs it in DX Server
330
+ dxclient livesync pull-theme [options] - command for downloading theme files from DX Server to a target local theme folder
331
+ ```
332
+ ### DXClient Help commands
333
+
334
+ The following commands show the Help documents for DXClient command usage.
335
+
336
+ Use the following commands to display the Help document for DXClient:
337
+
338
+ ```
339
+ dxclient
340
+ ```
341
+
342
+ ```
343
+ dxclient -h, --help
344
+ ```
345
+
346
+ Use the following command to display the DXClient version number:
347
+
348
+ ```
349
+ dxclient -V, --version
350
+ ```
351
+
352
+ Use the following command to skip prompt of click-through license acceptance agreement:
353
+
354
+ ```
355
+ dxclient accept-license
356
+ ```
357
+
358
+ Use the following command to display the detailed help for a specific command:
359
+
360
+ ```
361
+ dxclient help [command]
362
+ ```
363
+
364
+ Use the following command to show version compatibility details between DX Core and DXClient:
365
+
366
+ ```
367
+ dxclient version-compat [command] [options]
368
+
369
+ ```
370
+ Command options
371
+ ```
372
+ -hostname <value>
373
+ Use this attribute to specify the hostname of the target server
374
+
375
+ -dxConnectProtocol <value>
376
+ Use this attribute to specify the protocol with which to connect to the CW server
377
+
378
+ -dxConnectUsername <value>
379
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
380
+
381
+ -dxConnectPassword <value>
382
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
383
+
384
+ -dxConnectPort <value>
385
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
386
+ ```
387
+
388
+ ### 1. Deploy Portlet
389
+
390
+ Deploy-portlet command is used to deploy new or updated portlets to target DX Servers using the provided input xmlaccess file and path of the deployable war.
391
+
392
+ Commands Description
393
+ ```
394
+ dxclient deploy-portlet
395
+ This command invokes the deploy-portlet tool inside the DXClient. The deploy-portlet dxtool uses the provided files and execute the deploy portlets task using the above available endpoints.
396
+ ```
397
+
398
+ **Help command**
399
+ This command shows the help document on the `deploy-portlet` command usage:
400
+ ```
401
+ dxclient deploy-portlet -h
402
+ ```
403
+ **Required files**
404
+ Xml file: This xml file should contain the definition of the web application along with the details of the portlet\(s\) to be deployed. The web archive file path referred to in this file inside the URL element is ignored, but the URL element itself must exist as it is dynamically replaced when the command is executed. A sample XML file for deploying portlet\(s\) can be found in the samples directory of DXClient \(samples/DeployPortlet.xml\) or in DX server located in the following directory: PortalServer\_root/doc/xml-samples/DeployPortlet.xml.
405
+
406
+ Portlet Application web archive file:This web archive .war file should contain the necessary portlet artifacts for deployment. Reference the Importing WAR files[https://help.hcltechsw.com/digital-experience/8.5/admin-system/adxmlref_import_war.html] for more details.
407
+
408
+ **Command options**
409
+ ```
410
+ -hostname <value>
411
+ Use this attribute to specify the hostname of the target server
412
+
413
+ -dxProtocol <value>
414
+ Use this attribute to specify the protocol with which to connect to the server
415
+
416
+ -dxPort <value>
417
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
418
+
419
+ -xmlConfigPath <value>
420
+ Use this attribute to specify the path to DX configuration endpoint
421
+
422
+ -dxUsername <value>
423
+ Use this attribute to specify the username that is required for authenticating with the server
424
+
425
+ -dxPassword <value>
426
+ Use this attribute to specify the password that is required for authenticating with the server
427
+
428
+ -dxConnectUsername <value>
429
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
430
+
431
+ -dxConnectPassword <value>
432
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
433
+
434
+ -dxConnectPort <value>
435
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
436
+
437
+ -xmlFile <xml file name with absolute path of the xmlaccess input file>
438
+ Use this attribute to specify the xml file that will be used while executing the deploy portlet task. For an example, see the DeployPortlet.xml file in the directory dxclient/samples/sample-xml-files/
439
+
440
+ -warFile <war file name with absolute path of the deployable war file>
441
+ Use this attribute to specify the path of the war file to be deployed. For an example, see the WelcomePortlet.war file in the directory dxclient/samples/sample-xml-files/
442
+
443
+ **Note:** Mandatory parameters xmlFile and warFile should be passed into the command line.
444
+ ```
445
+
446
+ Example Usage:
447
+ ```
448
+ dxclient deploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -xmlFile <xml-file-with-path> -warFile <war-file-with-path>
449
+ ```
450
+
451
+ ### 2. Undeploy Portlet
452
+
453
+ Undeploy-portlet command is used to undeploy the deployed portlets in the target DX Servers.
454
+
455
+ **Note:** Undeploy-portlet will take the back up of deployed portlet application's xml file and application(EAR) if user has given enableBackup as true. By default enableBackup is set to true and placed in the `<working-directory>/store/outputFiles/portlets/backup/undeploy-portlet/`. In case if undeployed portlet is required, then the user can restore the portlet WAR file from the downloaded portlet application EAR file along with the exported deployable portlet application XML file.
456
+
457
+ Commands Description
458
+ ```
459
+ dxclient undeploy-portlet
460
+ This command invokes the undeploy-portlet tool inside the DXClient. The undeploy-portlet dxtool uses the provided files and execute the undeploy portlet task.
461
+ ```
462
+
463
+ **Help command**
464
+ This command shows the help information for `undeploy-portlet` command usage:
465
+ ```
466
+ dxclient undeploy-portlet -h
467
+ ```
468
+ **Required files**
469
+ ```
470
+ Xml file: This file should contain the definition of the web application along with the undeploy portlet details.
471
+ ```
472
+ **Command options**
473
+ ```
474
+ -hostname <value>
475
+ Use this attribute to specify the hostname of the target server
476
+
477
+ -dxProtocol <value>
478
+ Use this attribute to specify the protocol with which to connect to the server
479
+
480
+ -dxPort <value>
481
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
482
+
483
+ -xmlConfigPath <value>
484
+ Use this attribute to specify the path to DX configuration endpoint
485
+
486
+ -dxUsername <value>
487
+ Use this attribute to specify the username that is required for authenticating with the server
488
+
489
+ -dxPassword <value>
490
+ Use this attribute to specify the password that is required for authenticating with the server
491
+
492
+ -xmlFile <xml file name with absolute path of the xmlaccess input file>
493
+ Use this attribute to specify the xml file that will be used while executing the deploy portlet task. For an example, see the UndeployPortlet.xml file in the directory `<working-directory>/samples/sample-xml-files/`
494
+
495
+ -enableBackup <value>
496
+ Use this attribute to take the backup of portlet application before undeploying it
497
+ ```
498
+
499
+ Commands required when enableBackup is set to true
500
+ ```
501
+ -dxConnectPort <value>
502
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
503
+
504
+ -dxConnectUsername <value>
505
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
506
+
507
+ -dxConnectPassword <value>
508
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
509
+
510
+ -dxSoapPort <Soap port of the DX server>
511
+ Use this attribute to specify Soap port of the DX server
512
+
513
+ -dxProfileName <Profile name of the DX core server>
514
+ Use this attribute to specify the profile name of the DX core server
515
+
516
+ -dxProfilePath <Profile path of the DX core server>
517
+ Use this attribute to specify the profile path of the DX core server
518
+ ```
519
+ **Note:** Mandatory parameter xmlFile should be passed into the command line.
520
+
521
+ Example Usage:
522
+ ```
523
+ dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path>
524
+ ```
525
+ Example Usage with dxProfileName and when enableBackup is set to true:
526
+ ```
527
+ dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -enableBackup true -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX core server profile>
528
+ ```
529
+ Example Usage with dxProfilePath and when enableBackup is set to true:
530
+ ```
531
+ dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -enableBackup true -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfilePath <Profile path of the DX core server profile>
532
+ ```
533
+
534
+ ### 3. XML Access
535
+
536
+ The `xmlaccess` command is used to export or import pages or portlet configurations from a target HCL DX 9.5 CF 19 or higher server using a provided input XMLAccess file.
537
+
538
+ Command Description:
539
+ ```
540
+ dxclient xmlaccess -xmlFile <path>
541
+ ```
542
+
543
+ **Help command**
544
+ This command shows the help information for `xmlaccess` command usage:
545
+ ```
546
+ dxclient xmlaccess -h
547
+ ```
548
+ **Required files**
549
+ ```
550
+ Xml file: This XML file should contain the configuration update or export operation for the web application
551
+ ```
552
+ **Command options**
553
+ ```
554
+ -dxProtocol <value>
555
+ Use this attribute to specify the protocol with which to connect to the DX server (wp_profile):
556
+
557
+ -hostname <value>
558
+ Use this attribute to specify the hostname of the target DX server:
559
+
560
+ -dxPort <value>
561
+ Use this attribute to specify the port on which to connect to the DX server (wp_profile),for Kubernetes Environment dxPort is 443:
562
+
563
+ -xmlConfigPath <value>
564
+ Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config):
565
+
566
+ -dxUsername <value>
567
+ Use this attribute to specify the username to authenticate with the DX server (wp_profile):
568
+
569
+ -dxPassword <value>
570
+ Use this attribute to specify the password for the user in the "dxUsername" attribute:
571
+
572
+ -xmlFile <Absolute or relative path to xmlaccess input file>
573
+ Use this attribute to specify the local path to the XMLAccess file. Sample Files for creating or deleting pages can be found under the directory `dxclient/samples/sample-xml-files/`:
574
+
575
+ ```
576
+ **Note:** Mandatory parameter xmlFile should be passed into the command line.
577
+
578
+ Example usage:
579
+ ```
580
+ dxclient xmlaccess -xmlFile <xml-file-with-path>
581
+ ```
582
+
583
+ ### 4. Deploy Script Application
584
+
585
+ Deploy Script Application dxtool is used to deploy the script based applications either from local or source environments to different target environments. This tool will push files that are associated with script-based applications to a Script Application instance in a Web Content Manager Site Library by running below commands.
586
+
587
+ Commands Description
588
+ ```
589
+ dxclient deploy-scriptapplication
590
+
591
+ This command invokes the deploy-script-application tool inside the DXClient. This dxtool uses the provided files and executes the deploy script application task to the provided target DX server.
592
+ ```
593
+ **Help command**
594
+ This command shows the help document on the `deploy-scriptapplication` command:
595
+ ```
596
+ dxclient deploy-scriptapplication pull -h
597
+
598
+ dxclient deploy-scriptapplication push -h
599
+ ```
600
+ **Command options**
601
+ ```
602
+ push [OPTIONS]
603
+ Create or update the content of a Script Application in the DX server
604
+ pull [OPTIONS]
605
+ Downloads the content of a Script Application present in the DX server
606
+ ```
607
+ **Required options - Pull command**
608
+ ```
609
+ -dxProtocol <value>
610
+ Use this attribute to specify the protocol of the target server.
611
+ -hostname <value>
612
+ Use this attribute to specify the hostname of the target server.
613
+ -dxPort <value>
614
+ Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
615
+ -dxUsername <value>
616
+ The name of the dxUsername for authentication.
617
+ -dxPassword <value>
618
+ The password of the dxUsername for authentication.
619
+ -wcmContentID <value>
620
+ WCM content ID of the Script Application instance.
621
+ -virtualPortalContext <value>
622
+ The context of the virtual portal that contains the Script Application instance that you want to create or update.
623
+ -projectContext <value>
624
+ The context of the portal project that manages the publication of changes to the Script Application content.
625
+ ```
626
+
627
+ **Required options - Push command**
628
+ ```
629
+ -dxProtocol <value>
630
+ Use this attribute to specify the protocol of the target server.
631
+ -hostname <value>
632
+ Use this attribute to specify the hostname of the target server.
633
+ -dxPort <value>
634
+ Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
635
+ -dxUsername <value>
636
+ The name of the dxUsername for authentication.
637
+ -dxPassword <value>
638
+ The password of the dxUsername for authentication.
639
+ -wcmContentName <value>
640
+ Name of the Script Application instance to be created or updated.
641
+ -wcmContentPath <value>
642
+ Full WCM path of the Script Application instance to be created or updated.
643
+ You cannot use this argument with -wcmSiteArea and -wcmContentName.
644
+ -wcmContentID <value>
645
+ WCM content ID only if you are updating an existing Script Application instance on a portal page.
646
+ -wcmContentTitle <value>
647
+ Sets or updates the title of the Script Application instance.
648
+ -wcmSiteArea <value>
649
+ SiteArea of the Script Application content.
650
+ -contenthandlerPath <value>
651
+ The path to the contenthandler servlet on the Script Application server.
652
+ -contentRoot <value>
653
+ Absolute or relative path to the Script Application's content.
654
+ -virtualPortalContext <value>
655
+ The context of the virtual portal that contains the Script Application instance that you want to create or update.
656
+ -projectContext <value>
657
+ The context of the portal project that manages the publication of changes to the Script Application content.
658
+ -prebuiltZip <value>
659
+ Path to an existing compressed file that provides the content to be pushed to the portal instead of the -contentRoot option.
660
+ Note: When -prebuiltZip is specified, the main HTML file path must be relative to the top-level directory in the compressed file.
661
+ -mainHtmlFile <value>
662
+ Path to the main HTML file of the Script Application.
663
+
664
+ **Note:** Mandatory parameters contentRoot and prebuiltZip should be passed into the command line.
665
+ ```
666
+
667
+ Example Usage:
668
+ ```
669
+ Script Application Pull , execute
670
+
671
+ dxclient deploy-scriptapplication pull -wcmContentID <wcmContentID>
672
+
673
+ The outputfile for pull will be generated inside store/outputFiles/sp-pull-output
674
+
675
+ If the options are configured in dist/configuration/config.json, then execute
676
+
677
+ dxclient deploy-scriptapplication pull
678
+
679
+ dxclient deploy-scriptapplication push , execute
680
+
681
+ dxclient deploy-scriptapplication push -contentRoot /temp -wcmSiteArea "Script Application Library/Script Applications/" -wcmContentName DemoScriptApplication
682
+
683
+ If the options are configured in dist/configuration/config.json, then execute
684
+
685
+ dxclient deploy-scriptapplication push
686
+ ```
687
+
688
+ ### 5. Deploy Theme
689
+
690
+ Deploy-theme command is used to create and update the existing theme into target DX Servers using the provided theme registration xml file, deployable EAR file and WebDAV theme collection.
691
+
692
+ Commands Description
693
+ ```
694
+ dxclient deploy-theme
695
+ This command invokes the deploy-theme tool inside the DXClient. This command uses the provided files and execute the deploy theme task.
696
+ ```
697
+ **Help command**
698
+ This command shows the help document on the `deploy-theme` command usage:
699
+ ```
700
+ dxclient deploy-theme -h
701
+ ```
702
+ **Required files**
703
+ ```
704
+ Theme Registration XML file: This XML file is required to register the theme into DX Server and should contain the details of the theme. The xml file referred in this file should be made reachable while executing the deploy theme task.
705
+
706
+ Theme deployable EAR file: This EAR file containing theme data will be used for deploying it into the WebSphere Application Server.
707
+
708
+ WebDAV theme collection: The theme collection folder/zip will be used to create or update the collection in WebDAV file store of the DX Server.
709
+ ```
710
+
711
+ This command can execute below one or more tasks together:
712
+ 1. Theme Registration
713
+ 2. Theme EAR deployment
714
+ 3. WebDAV theme collection
715
+
716
+ **Common Command options**
717
+ ```
718
+ -hostname <value>
719
+ Use this attribute to specify the hostname of the target server
720
+
721
+ -dxProtocol <value>
722
+ Use this attribute to specify the protocol with which to connect to the server
723
+
724
+ -dxPort <value>
725
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
726
+
727
+ -dxUsername <value>
728
+ Use this attribute to specify the username that is required for authenticating with the server
729
+
730
+ -dxPassword <value>
731
+ Use this attribute to specify the password that is required for authenticating with the server
732
+
733
+ Required options for Theme Registration:
734
+
735
+ -xmlFile <xml file name with absolute path of the xmlaccess input file>
736
+ Use this attribute to specify the theme registration xml file that will be used while executing the deploy theme task. For an example, see the Theme-registration.xml file in the directory dxclient/samples/sample-xml-files/
737
+
738
+ -xmlConfigPath <value>
739
+ Use this attribute to specify the path to DX configuration endpoint
740
+
741
+ Required options for Theme EAR deployment:
742
+
743
+ -dxConnectPort <value>
744
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
745
+
746
+ -dxConnectUsername <value>
747
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
748
+
749
+ -dxConnectPassword <value>
750
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
751
+
752
+ -dxSoapPort <Soap port of the DX server>
753
+ Use this attribute to specify Soap port of the DX server
754
+
755
+ -dxProfileName <Profile name of the DX core server>
756
+ Use this attribute to specify the profile name of the DX core server
757
+
758
+ -dxProfilePath <Profile Path of the DX core server>
759
+ Use this attribute to specify the profile path of the DX core server
760
+
761
+ –applicationFile <Absolute or relative path to deployable theme ear file>
762
+ Use this attribute to specify the theme ear file path that is required while executing the deploy theme task
763
+
764
+ -applicationName <value>
765
+ Use this attribute to specify the theme application name
766
+
767
+ Required options for creating/updating WebDAV theme collection:
768
+
769
+ -themeName <value>
770
+ Use this attribute to specify the theme name of the collection created under WebDav server in DX
771
+
772
+ -themePath <value>
773
+ Use this attribute to specify the theme file path that contains all static files to be pushed into DX theme
774
+
775
+ -contenthandlerPath <value>
776
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):
777
+
778
+ Optional arguments:
779
+
780
+ -requestId <Unique Id of a previously triggered deploy theme request>
781
+ Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
782
+
783
+ **Note:** Mandatory parameters applicationFile, applicationName, themeName, themePath and xmlFile should be passed into the command line.
784
+ ```
785
+
786
+ Example Usage with dxProfileName:
787
+ ```
788
+ dxclient deploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationFile <application-file-with-path> -applicationName <application name> -themeName <theme-name> -themePath <theme-path> -dxProfileName <Profile name of the DX core server>
789
+ ```
790
+ Example Usage with dxProfilePath:
791
+ ```
792
+ dxclient deploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationFile <application-file-with-path> -applicationName <application name> -themeName <theme-name> -themePath <theme-path> -dxProfilePath <Profile path of the DX core server>
793
+ ```
794
+
795
+ ### 6. Undeploy Theme
796
+
797
+ undeploy-theme command is used to undeploy EAR application and undeploy WebDAV and unregister the registered theme from target DX server.
798
+
799
+ **Note**: If user sets the enableBackup as true then undeploy-theme will take the back up of deployed EAR theme,WebDAV theme collection and complete DX configuration export(not including users) and placed it in the backup folder. When the user is downloading EAR, WeDAV and XML to backup we seprate it by `store/outputFiles/themes/backup/foldername`.
800
+
801
+ example for backup of EAR, it is placed in `store/outputFiles/themes/backup/application`.
802
+
803
+ In case if undeployed theme is required,then user can restore the theme back using the back up files.
804
+
805
+ Commands Description
806
+ ```
807
+ dxclient undeploy-theme
808
+ This command invokes the undeploy-theme tool inside the DXClient. This command uses the provided files and execute the undeploy theme task.
809
+ ```
810
+ **Required files**
811
+ ```
812
+ Theme Unregistration XML file: This XML file is required to unregister the theme into DX Server and should contain the details of the theme. The xml file referred in this file should be made reachable while executing the undeploy theme task.
813
+
814
+ ```
815
+
816
+ This command can execute below one or more tasks together:
817
+ 1. Theme Unregistration
818
+ 2. Theme EAR undeploy
819
+ 3. WebDAV theme collection undeploy
820
+
821
+ **Common Command options**
822
+ ```
823
+ -hostname <value>
824
+ Use this attribute to specify the hostname of the target server
825
+
826
+ -dxProtocol <value>
827
+ Use this attribute to specify the protocol with which to connect to the server
828
+
829
+ -dxPort <value>
830
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
831
+
832
+ -dxUsername <value>
833
+ Use this attribute to specify the username that is required for authenticating with the server
834
+
835
+ -dxPassword <value>
836
+ Use this attribute to specify the password that is required for authenticating with the server
837
+
838
+ -contenthandlerPath <value>
839
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):
840
+
841
+ -enableBackup <value>
842
+ Use this attribute to take the backup before undeploying theme
843
+
844
+ **Note** : User can sets the sets the enableBackup as true to take backup before undeploying, enableBackup is set to false by default.
845
+
846
+ Required options for Theme Unregistration:
847
+
848
+ -xmlFile <xml file name with absolute path of the xmlaccess input file>
849
+ Use this attribute to specify the theme registration xml file that will be used while executing the undeploy theme task. For an example, see the Theme-registration.xml file in the directory dxclient/samples/
850
+
851
+ -xmlConfigPath <value>
852
+ Use this attribute to specify the path to DX configuration endpoint
853
+
854
+ Required options for Theme EAR and WebDAV undeployment:
855
+
856
+ -dxConnectPort <value>
857
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
858
+
859
+ -dxConnectUsername <value>
860
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
861
+
862
+ -dxConnectPassword <value>
863
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
864
+
865
+ -dxSoapPort <Soap port of the DX server>
866
+ Use this attribute to specify Soap port of the DX server
867
+
868
+ -dxProfileName <Profile name of the DX core server profile>
869
+ Use this attribute to specify the profile name of the DX core server
870
+
871
+ -dxProfilePath <Profile path of the DX core server profile>
872
+ Use this attribute to specify the profile path of the DX core server
873
+
874
+ -applicationName <value>
875
+ Use this attribute to specify the EAR application name
876
+
877
+ -themeName <value>
878
+ Use this attribute to specify the theme name of the collection created under WebDAV
879
+
880
+ **Note:** Mandatory parameters applicationName, themeName and xmlFile should be passed into the command line.
881
+ ```
882
+
883
+ Example Usage with dxProfileName:
884
+ ```
885
+ dxclient undeploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationName <application name> -themeName <theme-name> -enableBackup <enable-backup> -dxProfileName <Profile name of the DX core server profile>
886
+ ```
887
+ Example Usage with dxProfilePath:
888
+ ```
889
+ dxclient undeploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationName <application name> -themeName <theme-name> -enableBackup <enable-backup> -dxProfilePath <Profile path of the DX core server profile>
890
+ ```
891
+
892
+ ### 7. Undeploy Script Application
893
+
894
+ Undeploy Script Application command is used to un-deploy an existing or delete the newly deployed script application from the target DX Server.
895
+
896
+ **Note:**
897
+ Undeploy script application will take the back up of an already deployed script application, if user has set "enableBackup" as true in the configuration file and deletes it. The backup files are placed under the `store/outputFiles/scriptApplications/backup/{wcmContentId}` by default.
898
+
899
+ Commands Description
900
+ ```
901
+ dxclient undeploy-scriptapplication
902
+ This command invokes the undeploy-scriptapplication tool inside the DXClient. The undeploy-scriptapplication dxtool uses the provided files and execute the undeploy scriptapplication task.
903
+ ```
904
+ **Help command**
905
+ This command shows the help information for `undeploy-scriptapplication` command usage:
906
+ ```
907
+ dxclient undeploy-scriptapplication -h
908
+ ```
909
+ **Required command options**
910
+ ```
911
+ -hostname <value>
912
+ Use this attribute to specify the hostname of the target server.
913
+
914
+ -dxProtocol <value>
915
+ Use this attribute to specify the protocol with which to connect to the server.
916
+
917
+ -dxPort <value>
918
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443).
919
+
920
+ -dxUsername <value>
921
+ Use this attribute to specify the username that is required for authenticating with the server.
922
+
923
+ -dxPassword <value>
924
+ Use this attribute to specify the password that is required for authenticating with the server.
925
+
926
+ -wcmContentID <value>
927
+ WCM content ID only if you are updating an existing Script Application instance on a portal page.
928
+
929
+ -contenthandlerPath <value>
930
+ The path to the contenthandler servlet on the Script Application server.
931
+
932
+ -virtualPortalContext <value>
933
+ The context of the virtual portal that contains the Script Application instance that you want to create or update.
934
+
935
+ -projectContext <value>
936
+ The context of the portal project that manages the publication of changes to the Script Application content.
937
+
938
+ -f
939
+ The -f flag is to delete the Script Application forcefully overstepping the prompt.
940
+
941
+ ```
942
+ Example Usage:
943
+ ```
944
+ dxclient undeploy-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -f
945
+ ```
946
+
947
+ ## 8.Restore Script Application
948
+
949
+ Restore Script Application command is used to restore the script application into one of its previous versions already present in the target DX Server.
950
+
951
+ Commands Description
952
+ ```
953
+ dxclient restore-scriptapplication
954
+ This command invokes the restore-scriptapplication tool inside the DXClient. The restore-scriptapplication dxtool uses the provided files and execute the restore scriptapplication task.
955
+ ```
956
+ **Help command**
957
+ This command shows the help information for `restore-scriptapplication` command usage:
958
+ ```
959
+ dxclient restore-scriptapplication -h
960
+ ```
961
+ **Required command options**
962
+ ```
963
+ -hostname <value>
964
+ Use this attribute to specify the hostname of the target server
965
+
966
+ -dxProtocol <value>
967
+ Use this attribute to specify the protocol with which to connect to the server
968
+
969
+ -dxPort <value>
970
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
971
+
972
+ -dxUsername <value>
973
+ Use this attribute to specify the username that is required for authenticating with the server
974
+
975
+ -dxPassword <value>
976
+ Use this attribute to specify the password that is required for authenticating with the server
977
+
978
+ -wcmContentID <value>
979
+ WCM content ID only if you are updating an existing Script Application instance on a portal page.
980
+
981
+ -contenthandlerPath <value>
982
+ The path to the contenthandler servlet on the Script Application server.
983
+
984
+ -virtualPortalContext <value>
985
+ The context of the virtual portal that contains the Script Application instance that you want to create or update.
986
+
987
+ -projectContext <value>
988
+ The context of the portal project that manages the publication of changes to the Script Application content.
989
+
990
+ -versionName <value>
991
+ Use this attribute to specify the versionname that is restore version of Script Application.
992
+ Note: When -versionName is not specified, the script application will rollback to the previous version default.
993
+ -restoreAsPublished <value>
994
+ Use this attribute to specify the restore as a draft or replace the published version of Script Application.
995
+
996
+ ```
997
+ Example Usage:
998
+ ```
999
+ dxclient restore-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -versionName <versionName> -restoreAsPublished <restoreAsPublished>
1000
+ ```
1001
+
1002
+ ### 9. Export Content of a WCM Library
1003
+
1004
+ The export command is used to export the content of a wcm library for translation into a .csv file at the location specified by the user.
1005
+
1006
+ Commands Description
1007
+ ```
1008
+ dxclient mls-export
1009
+ The export command would create a new .csv file with an auto-generated file name in a file path specified by the user every-time the export command is run.
1010
+ ```
1011
+ **Required command options**
1012
+ ```
1013
+ -dxProtocol <value>
1014
+ Use this attribute to specify the protocol with which to connect to the DX server
1015
+
1016
+ -hostname <value>
1017
+ Use this attribute to specify the hostname of the DX server
1018
+
1019
+ -dxPort <value>
1020
+ Use this attribute to specify the port on which to connect to the DX server
1021
+
1022
+ -contenthandlerPath <value>
1023
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1024
+
1025
+ -dxUsername <value>
1026
+ Use this attribute to specify the username that is required for authenticating with the server
1027
+
1028
+ -dxPassword <value>
1029
+ Use this attribute to specify the password that is required for authenticating with the server
1030
+
1031
+ -wcmLibraryId <value>
1032
+ WCM library ID(s) within quotation("") to export the contents of the library. For multiple WCM library ids, enter separated by comma.
1033
+
1034
+ -wcmLibraryName <value>
1035
+ Provide the WCM library name(s) within quotation("") to export the contents of the library. For multiple WCM library name, enter separated by comma.
1036
+
1037
+ -lastModifiedAfter <value>
1038
+ Last modified after will give the contents of WCM library id and name from specified date and time in GMT format.
1039
+
1040
+ -wcmProjectName <value>
1041
+ Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.
1042
+
1043
+ -exportPath <value>
1044
+ The path to the exports the wcm contents of a library.
1045
+
1046
+ -virtualPortalContext <value>
1047
+ The context of the virtual portal from which mls library should be exported.
1048
+
1049
+ **Note:** Mandatory parameter exportPath should be passed into the command line.
1050
+ ```
1051
+
1052
+ Example Usage:
1053
+ ```
1054
+ To Export contents from Library :
1055
+ dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1056
+ -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmLibraryId <wcmLibraryId> -wcmLibraryName <wcmLibraryName> -lastModifiedAfter <lastModifiedAfter> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>
1057
+
1058
+ To Export contents from Project :
1059
+ dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1060
+ -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmProjectName <wcmProjectName> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>
1061
+ ```
1062
+
1063
+ ### 10. Import Translated Contents into DX
1064
+
1065
+ The import command is used to import the translated contents into DX at the location specified by the user.
1066
+
1067
+ Commands Description
1068
+ ```
1069
+ dxclient mls-import
1070
+ The import command imports the translated contents into DX and It would overwrite any translations which are already present in the content of the environment.
1071
+ ```
1072
+
1073
+ **Required command options**
1074
+ ```
1075
+ -dxProtocol <value>
1076
+ Use this attribute to specify the protocol with which to connect to the DX server
1077
+
1078
+ -hostname <value>
1079
+ Use this attribute to specify the hostname of the DX server
1080
+
1081
+ -dxPort <value>
1082
+ Use this attribute to specify the port on which to connect to the DX server
1083
+
1084
+ -contenthandlerPath <value>
1085
+ Use this attribute to specify the context root on which to connect to the DX server
1086
+
1087
+ -dxUsername <value>
1088
+ Use this attribute to specify the username that is required for authenticating with the server
1089
+
1090
+ -dxPassword <value>
1091
+ Use this attribute to specify the password that is required for authenticating with the server
1092
+
1093
+ -importPath <value>
1094
+ The path(s) (separated by comma) to import the translated contents into DX.
1095
+
1096
+ -wcmProjectName <value>
1097
+ Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.
1098
+
1099
+ -forceImport <value>
1100
+ Optional attribute: Flag to forcefully import the content. This allows the import process to proceed even if the content is modified in the DX since the last export. (e.g. true or false)
1101
+
1102
+ -virtualPortalContext <value>
1103
+ The context of the virtual portal to which mls library should be imported.
1104
+
1105
+ **Note:** Mandatory parameter importPath should be passed into the command line.
1106
+
1107
+ ```
1108
+ Example Usage:
1109
+ ```
1110
+ dxclient mls-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1111
+ -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -importPath <importPath> -wcmProjectName <wcmProjectName> -virtualPortalContext <virtualPortalContext>
1112
+ ```
1113
+
1114
+ ### 11. Deploy Application
1115
+
1116
+ Deploy-application command is used to deploy EAR file into the WebSphere Application Server.
1117
+
1118
+ Commands Description
1119
+ ```
1120
+ dxclient deploy-application
1121
+ This command invokes the deploy-application tool inside the DXClient. This command uses the provided files and execute the deploy application task.
1122
+ ```
1123
+ **Help command**
1124
+ This command shows the help information for `deploy-application` command usage:
1125
+ ```
1126
+ dxclient deploy-application -h
1127
+ ```
1128
+ **Required files**
1129
+ ```
1130
+ Deployable EAR file: This EAR file will be used for deploying it into the WebSphere Application Server.
1131
+ ```
1132
+ **Common Command options**
1133
+ ```
1134
+ -hostname <value>
1135
+ Use this attribute to specify the hostname of the target server
1136
+
1137
+ -dxProtocol <value>
1138
+ Use this attribute to specify the protocol with which to connect to the server
1139
+
1140
+ -dxPort <value>
1141
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1142
+
1143
+ -dxUsername <value>
1144
+ Use this attribute to specify the username that is required for authenticating with the server
1145
+
1146
+ -dxPassword <value>
1147
+ Use this attribute to specify the password that is required for authenticating with the server
1148
+
1149
+ Required options for application deployment:
1150
+
1151
+ -dxConnectPort <value>
1152
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1153
+
1154
+ -dxConnectUsername <value>
1155
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1156
+
1157
+ -dxConnectPassword <value>
1158
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1159
+
1160
+ -dxSoapPort <Soap port of the DX server>
1161
+ Use this attribute to specify Soap port of the DX server
1162
+
1163
+ -dxProfileName <Profile name of the DX core server>
1164
+ Use this attribute to specify the profile name of the DX core server
1165
+
1166
+ -dxProfilePath <Profile path of the DX core server>
1167
+ Use this attribute to specify the profile path of the DX core server
1168
+
1169
+ –applicationFile <Absolute or relative path to deployable ear file>
1170
+ Use this attribute to specify the ear file path that is required while executing the deploy application task
1171
+
1172
+ -applicationName <value>
1173
+ Use this attribute to specify the application name
1174
+
1175
+ Optional arguments:
1176
+
1177
+ -requestId <Unique Id of a previously triggered deploy application request>
1178
+ Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1179
+
1180
+ **Note:** Mandatory parameters applicationFile and applicationName should be passed into the command line.
1181
+
1182
+ ```
1183
+ Example Usage with dxProfileName:
1184
+ ```
1185
+ dxclient deploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationFile <application-file-with-path> -applicationName <application name> -dxProfileName <Profile name of the DX core server>
1186
+ ```
1187
+
1188
+ Example Usage with dxProfilePath:
1189
+ ```
1190
+ dxclient deploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationFile <application-file-with-path> -applicationName <application name> -dxProfilePath <Profile path of the DX core server>
1191
+ ```
1192
+
1193
+ ### 12. Restart DX Core
1194
+
1195
+ restart-dx-core command is used to restart the DX Core server.
1196
+ **Note:** It is not recommended to run this command in Kubernetes based deployments. To restart all the pods, use the Kubernetes interfaces like kubectl.
1197
+
1198
+ Commands Description
1199
+ ```
1200
+ dxclient restart-dx-core
1201
+ This command invokes the restart-dx-core tool inside the DXClient and executes the DX Core restart action.
1202
+ ```
1203
+ **Help command**
1204
+ This command shows the help information for `restart-dx-core` command usage:
1205
+ ```
1206
+ dxclient restart-dx-core -h
1207
+ ```
1208
+ **Command options**
1209
+ ```
1210
+ -hostname <value>
1211
+ Use this attribute to specify the hostname of the target server
1212
+ -dxUsername <value>
1213
+ Use this attribute to specify the username that is required for authenticating with the DX Core
1214
+ -dxPassword <value>
1215
+ Use this attribute to specify the password that is required for authenticating with the DX Core
1216
+ -dxConnectPort <value>
1217
+ Use this attribute to specify the port number of the cw_profile
1218
+ -dxConnectUsername <value>
1219
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1220
+ -dxConnectPassword <value>
1221
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1222
+ -dxProfileName <Profile name of the DX core server>
1223
+ Use this attribute to specify the profile name of the DX Core server
1224
+ -dxProfilePath <Profile path of the DX core server>
1225
+ Use this attribute to specify the profile path of the DX Core server
1226
+
1227
+ Optional arguments:
1228
+ -requestId <Unique Id of a previously triggered restart request>
1229
+ Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1230
+
1231
+ ```
1232
+ Example Usage with dxProfileName:
1233
+ ```
1234
+ dxclient restart-dx-core -hostname <host-name> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX core server>
1235
+ ```
1236
+ Example Usage with dxProfilePath:
1237
+ ```
1238
+ dxclient restart-dx-core -hostname <host-name> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfilePath <Profile path of the DX core server>
1239
+ ```
1240
+
1241
+ ### 13. Manage Syndicator
1242
+
1243
+ manage-syndicator command is used to enable/disable syndicator in the target server.
1244
+
1245
+ Commands Description
1246
+ ```
1247
+ dxclient manage-syndicator
1248
+ This command invokes the manage-syndicator tool inside the DXClient. The manage-syndicator dxtool is used to enable/disable syndicator.
1249
+ ```
1250
+ **Help command**
1251
+ This command shows the help information for `manage-syndicator` command usage:
1252
+ ```
1253
+ dxclient manage-syndicator -h
1254
+ ```
1255
+ **Command options**
1256
+ ```
1257
+ -hostname <value>
1258
+ Use this attribute to specify the hostname of the target server
1259
+ -dxProtocol <value>
1260
+ Use this attribute to specify the protocol with which to connect to the server
1261
+ -dxPort <value>
1262
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1263
+ -dxUsername <value>
1264
+ Use this attribute to specify the username that is required for authenticating with the server
1265
+ -dxPassword <value>
1266
+ Use this attribute to specify the password that is required for authenticating with the server
1267
+ -contenthandlerPath <value>
1268
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1269
+ -UUID <value>
1270
+ Use this attribute to specify the UUID of the syndicator instance
1271
+ -enable <value>
1272
+ Use this attribute to specify the enable/disable the syndicator instance. This value can be true or false. If true then enable the syndicator otherwise it will disable the syndicator
1273
+
1274
+ ```
1275
+ Example Usage:
1276
+ ```
1277
+ dxclient manage-syndicator -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>
1278
+ ```
1279
+
1280
+ ### 14. Manage Subscriber
1281
+
1282
+ manage-subscriber command is used to enable/disable subscriber in the target server.
1283
+
1284
+ Commands Description
1285
+ ```
1286
+ dxclient manage-subscriber
1287
+ This command invokes the manage-subscriber tool inside the DXClient. The manage-subscriber dxtool is used to enable/disable subscriber.
1288
+ ```
1289
+ **Help command**
1290
+ This command shows the help information for `manage-subscriber` command usage:
1291
+ ```
1292
+ dxclient manage-subscriber -h
1293
+ ```
1294
+ **Command options**
1295
+ ```
1296
+ -hostname <value>
1297
+ Use this attribute to specify the hostname of the target server
1298
+ -dxProtocol <value>
1299
+ Use this attribute to specify the protocol with which to connect to the server
1300
+ -dxPort <value>
1301
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1302
+ -dxUsername <value>
1303
+ Use this attribute to specify the username that is required for authenticating with the server
1304
+ -dxPassword <value>
1305
+ Use this attribute to specify the password that is required for authenticating with the server
1306
+ -contenthandlerPath <value>
1307
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1308
+ -UUID <value>
1309
+ Use this attribute to specify the UUID of the subscriber instance
1310
+ -enable <value>
1311
+ Use this attribute to specify the enable/disable the subscriber instance. This value can be true or false. If true then enable the subscriber otherwise it will disable the subscriber
1312
+
1313
+ ```
1314
+ Example Usage:
1315
+ ```
1316
+ dxclient manage-subscriber -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>
1317
+ ```
1318
+
1319
+ ### 15. Manage-syndicator get-syndication-report
1320
+
1321
+ Manage-syndicator get-syndication-report command is used to fetch the syndicator failed reports.
1322
+
1323
+ Commands Description
1324
+ ```
1325
+ dxclient manage-syndicator get-syndication-report
1326
+ This command invokes the report generation of items that failed to syndicate in DX through DXClient. If the user provides syndicator UUID it will fetch the report of items that failed to syndicate with respect to the UUID, otherwise, it will display items that failed to syndicate for all syndicators present in the DX environment provided. The report is available in HTML format.
1327
+ ```
1328
+ **Help command**
1329
+ This command shows the help information for `manage-syndicator get-syndication-report` command usage:
1330
+ ```
1331
+ dxclient manage-syndicator get-syndication-report -h
1332
+ ```
1333
+ **Command options**
1334
+ ```
1335
+ -hostname <value>
1336
+ Use this attribute to specify the hostname of the target server
1337
+ -dxProtocol <value>
1338
+ Use this attribute to specify the protocol with which to connect to the server
1339
+ -dxPort <value>
1340
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1341
+ -dxUsername <value>
1342
+ Use this attribute to specify the username that is required for authenticating with the server
1343
+ -dxPassword <value>
1344
+ Use this attribute to specify the password that is required for authenticating with the server
1345
+ -contenthandlerPath <value>
1346
+ Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1347
+ -UUID <value>
1348
+ Use this attribute to specify the UUID of the syndicator instance
1349
+
1350
+ ```
1351
+ Example Usage with UUID:
1352
+ ```
1353
+ dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID>
1354
+ ```
1355
+ Example Usage without UUID:
1356
+ ```
1357
+ dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath>
1358
+ ```
1359
+
1360
+ ### 16. Shared Library
1361
+
1362
+ shared-library command is used to manage files in the shared library. The sub-command upload is used to `upload` jar files and sub-command `delete` is used to delete the files from the default shared library location provided below.
1363
+ Default shared Library: DXCLib
1364
+ Default shared library location: <dx-profile>/PortalServer/sharedLibrary
1365
+
1366
+ Commands Description
1367
+ ```
1368
+ dxclient shared-library upload
1369
+ This command invokes the shared library upload task inside the DXClient. This is used to upload jar files into the default shared library location.
1370
+ ```
1371
+ ```
1372
+ dxclient shared-library delete
1373
+ This command invokes the shared library delete task inside the DXClient. This is used to delete jar files from the default shared library location.
1374
+ ```
1375
+ **Help command**
1376
+ This command shows the help information for `shared-library upload` command usage:
1377
+ ```
1378
+ dxclient shared-library upload -h
1379
+ ```
1380
+ This command shows the help information for `shared-library delete` command usage:
1381
+ ```
1382
+ dxclient shared-library delete -h
1383
+ ```
1384
+ **Command options**
1385
+ ```
1386
+ -hostname <value>
1387
+ Use this attribute to specify the hostname of the target server
1388
+ -dxConnectPort <value>
1389
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1390
+ -dxConnectUsername <value>
1391
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1392
+ -dxConnectPassword <value>
1393
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1394
+ -dxProfileName <Profile name of the DX core server>
1395
+ Use this attribute to specify the profile name of the DX Core server
1396
+
1397
+ Command option for Upload
1398
+ -libFilePath <value>
1399
+ Use this attribute to specify the path to a jar/zip file or folder containing jars in it.
1400
+
1401
+ Command option for Delete
1402
+ -libFileNames <value>
1403
+ Use this attribute to specify the names of the jar files present in the shared library location on the server (e.g. "abc.jar,sample.jar,test.jar")
1404
+
1405
+ **Note:** Mandatory parameter libFilePath should be passed into the command line.
1406
+ For upload, The folder/zip should contain only jars files that are to be uploaded to the default shared library location
1407
+
1408
+ ```
1409
+ Example Usage:
1410
+ ```
1411
+ dxclient shared-library upload -hostname <host-name> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -libFilePath <path to jar/zip/Folder>
1412
+
1413
+ dxclient shared-library delete -hostname <host-name> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -libFileNames <file names>
1414
+ ```
1415
+
1416
+ ### 17. Delete DAM schema
1417
+
1418
+ Delete-dam-schema command is used to delete inactive DAM schema from persistence.
1419
+
1420
+ Commands Description
1421
+ ```
1422
+ dxclient delete-dam-schema
1423
+ ```
1424
+ **Help command**
1425
+ This command shows the help information for `delete-dam-schema` command usage:
1426
+ ```
1427
+ dxclient delete-dam-schema -h
1428
+ ```
1429
+ **Command options**
1430
+ ```
1431
+ -dxProtocol <value>
1432
+ Use this attribute to specify the protocol with which to connect to the server
1433
+ -hostname <value>
1434
+ Use this attribute to specify the hostname of the target server
1435
+ -dxUsername <value>
1436
+ Use this attribute to specify the username that is required for authenticating with the server
1437
+ -dxPassword <value>
1438
+ Use this attribute to specify the password that is required for authenticating with the server
1439
+ -damAPIPort <value>
1440
+ Use this attribute to specify the port number of the DAM server(for Kubernetes Environment default port is 443 )
1441
+ -ringAPIPort <value>
1442
+ Use this attribute to specify the port number of the DX Core API server(for Kubernetes Environment default port is 443 )
1443
+ -damAPIVersion <value>
1444
+ Use this attribute to specify the API Version number of DAM(for Kubernetes Environment default port is 443 )
1445
+ -ringAPIVersion <value>
1446
+ Use this attribute to specify the API Version number of DX Core(for Kubernetes Environment default port is 443 )
1447
+ -schemaVersion <value>
1448
+ Use this attribute to specify the DAM Schema Version(for Kubernetes Environment default port is 443 )
1449
+ Note : In case if the user do not enter the schemaVersion, it will prompt the user with a list of inactive schemas to select from and proceed forward.
1450
+ ```
1451
+
1452
+ Example Usage:
1453
+ ```
1454
+ dxclient delete-dam-schema -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -ringAPIVersion <ringAPIVersion> -damAPIVersion <damAPIVersion> -schemaVersion <schemaVersion>
1455
+ ```
1456
+
1457
+ ### 18. List DAM schema
1458
+
1459
+ list-dam-schemas command is used to list of all DAM schema.
1460
+
1461
+ Commands Description
1462
+ ```
1463
+ dxclient list-dam-schemas
1464
+ ```
1465
+ **Help command**
1466
+ This command shows the help information for `list-dam-schemas` command usage:
1467
+ ```
1468
+ dxclient list-dam-schemas -h
1469
+ ```
1470
+ **Command options**
1471
+ ```
1472
+ -dxProtocol <value>
1473
+ Use this attribute to specify the protocol with which to connect to the server
1474
+ -hostname <value>
1475
+ Use this attribute to specify the hostname of the target server
1476
+ -dxUsername <value>
1477
+ Use this attribute to specify the username that is required for authenticating with the server
1478
+ -dxPassword <value>
1479
+ Use this attribute to specify the password that is required for authenticating with the server
1480
+ -damAPIPort <value>
1481
+ Use this attribute to specify the port number of the DAM server(for Kubernetes Environment default port is 443 )
1482
+ -ringAPIPort <value>
1483
+ Use this attribute to specify the port number of the DX Core API server(for Kubernetes Environment default port is 443 )
1484
+ -damAPIVersion <value>
1485
+ Use this attribute to specify the API Version number of DAM(for Kubernetes Environment default port is 443 )
1486
+ -ringAPIVersion <value>
1487
+ Use this attribute to specify the API Version number of DX Core(for Kubernetes Environment default port is 443 )
1488
+ ```
1489
+
1490
+ Example Usage:
1491
+ ```
1492
+ dxclient list-dam-schemas -dxProtocol <dxProtocol> -hostname <hostname> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -ringAPIVersion <ringAPIVersion> -damAPIVersion <damAPIVersion>
1493
+ ```
1494
+
1495
+ ### 19. PZN Export
1496
+
1497
+ The `pzn-export` command is used to export the rules from the source server to a user-specified location.
1498
+
1499
+ Command Description:
1500
+ ```
1501
+ dxclient pzn-export
1502
+ ```
1503
+ **Help command:**
1504
+ This command shows the help information for `pzn-export` command usage:
1505
+ ```
1506
+ dxclient pzn-export -h
1507
+ ```
1508
+ **Command options:**
1509
+ ```
1510
+ -dxProtocol <value>
1511
+ Use this attribute to specify the protocol with which to connect to the DX server
1512
+
1513
+ -hostname <value>
1514
+ Use this attribute to specify the hostname of the target DX server
1515
+
1516
+ -dxPort <value>
1517
+ Use this attribute to specify the port on which to connect to the DX server ,for Kubernetes Environment dxPort is 443
1518
+
1519
+ -dxUsername <value>
1520
+ Use this attribute to specify the username to authenticate with the DX server
1521
+
1522
+ -dxPassword <value>
1523
+ Use this attribute to specify the password for the user in the "dxUsername" attribute
1524
+
1525
+ -targetPath <value>
1526
+ Use this attribute to specify the rule or folder containing the rules in the target workspace (default targetPath is '/'), which is the parent for the published nodes. The target path must exist before publishing
1527
+
1528
+ -targetWorkspace <value>
1529
+ Use this attribute to specify the name of the workspace containing the rules in DX server (default targetWorkspace is 'ROOTWORKSPACE')
1530
+
1531
+ -dxContextRoot <value>
1532
+ Use this attribute to specify the path to the context root on the DX server (e.g. /wps):
1533
+
1534
+ ```
1535
+ **Note:** targetPath and targetWorkspace are optional parameters. If the user does not pass the respective parameters then the default value will be taken.
1536
+
1537
+ Example usage:
1538
+
1539
+ ```
1540
+ dxclient pzn-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxContextRoot <dxContextRoot>
1541
+
1542
+ The outputfile for pzn export will be generated inside store/outputFiles/pznrules
1543
+ ```
1544
+
1545
+ ### 20. PZN Import
1546
+
1547
+ The `pzn-import` command is used to import the rules from the source server into the target server.
1548
+
1549
+ Command Description:
1550
+ ```
1551
+ dxclient pzn-import
1552
+ ```
1553
+ **Help command:**
1554
+ This command shows the help information for `pzn-import` command usage:
1555
+ ```
1556
+ dxclient pzn-import -h
1557
+ ```
1558
+ **Required files**
1559
+ ```
1560
+ Rules file: This file should contain the configuration XML representation of all the currently selected personalization objects.
1561
+ ```
1562
+ **Command options:**
1563
+ ```
1564
+ -dxProtocol <value>
1565
+ Use this attribute to specify the protocol with which to connect to the DX server
1566
+
1567
+ -hostname <value>
1568
+ Use this attribute to specify the hostname of the target DX server
1569
+
1570
+ -dxPort <value>
1571
+ Use this attribute to specify the port on which to connect to the DX server ,for Kubernetes Environment dxPort is 443
1572
+
1573
+ -dxUsername <value>
1574
+ Use this attribute to specify the username to authenticate with the DX server
1575
+
1576
+ -dxPassword <value>
1577
+ Use this attribute to specify the password for the user in the "dxUsername" attribute
1578
+
1579
+ -dxConnectUsername <value>
1580
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1581
+
1582
+ -dxConnectPassword <value>
1583
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1584
+
1585
+ -dxConnectPort <value>
1586
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1587
+
1588
+ -rulesFilePath <Absolute or relative path to import nodes file>
1589
+ Use this attribute to specify the path to the file containing the rules to be imported
1590
+
1591
+ -targetPath <value>
1592
+ Use this attribute to specify the rule or folder containing the rules in the target workspace (default targetPath is '/'), which is the parent for the published nodes. The target path must exist before publishing
1593
+
1594
+ -targetWorkspace <value>
1595
+ Use this attribute to specify the name of the workspace containing the rules in DX server (default targetWorkspace is 'ROOTWORKSPACE')
1596
+
1597
+ -dxContextRoot <value>
1598
+ Use this attribute to specify the path to the context root on the DX server (e.g. /wps):
1599
+
1600
+ ```
1601
+ **Note:** dxProtocol, hostname, dxPort, targetWorkspace and targetPath are optional parameters. If the user does not pass the respective parameters then the default value will be taken.
1602
+
1603
+ Example usage:
1604
+ ```
1605
+ dxclient pzn-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -rulesFilePath <rulesFilePath> -dxContextRoot <dxContextRoot>
1606
+ ```
1607
+
1608
+ ### 21. Resource Environment Provider
1609
+
1610
+ The `resource-env-provider` command is used to create, update, delete, export or import custom properties from an existing Resource Environment Provider.
1611
+
1612
+ Commands Description:
1613
+ ```
1614
+ dxclient resource-env-provider
1615
+ ```
1616
+ **Help command:**
1617
+ This command shows the help information for `resource-env-provider` command usage:
1618
+ ```
1619
+ dxclient resource-env-provider -h
1620
+ ```
1621
+
1622
+ ```
1623
+ dxclient resource-env-provider create-property -h
1624
+ dxclient resource-env-provider update-property -h
1625
+ dxclient resource-env-provider delete-property -h
1626
+ dxclient resource-env-provider export-properties -h
1627
+ dxclient resource-env-provider import-properties -h
1628
+ dxclient resource-env-provider retrieve-property -h
1629
+ ```
1630
+
1631
+ **Commands**
1632
+ ```
1633
+ resource-env-provider create-property [OPTIONS]
1634
+ Create a custom property from an existing Resource Environment Provider
1635
+
1636
+ resource-env-provider update-property [OPTIONS]
1637
+ Update a custom property from an existing Resource Environment Provider
1638
+
1639
+ resource-env-provider delete-property [OPTIONS]
1640
+ Delete a custom property from an existing Resource Environment Provider
1641
+
1642
+ resource-env-provider export-properties [OPTIONS]
1643
+ Export all the existing Resource Environment Provider
1644
+
1645
+ resource-env-provider import-properties [OPTIONS]
1646
+ Import all the existing Resource Environment Provider
1647
+
1648
+ resource-env-provider retrieve-property [OPTIONS]
1649
+ Retrieve a property from an existing Resource Environment Provider
1650
+ ```
1651
+
1652
+ **Required options for create, update or delete property Command options**
1653
+ ```
1654
+ -dxProtocol <value>
1655
+ Use this attribute to specify the protocol with which to connect to the server
1656
+
1657
+ -hostname <value>
1658
+ Use this attribute to specify the hostname of the target server
1659
+
1660
+ -dxPort <value>
1661
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1662
+
1663
+ -dxUsername <value>
1664
+ Use this attribute to specify the username that is required for authenticating with the server
1665
+
1666
+ -dxPassword <value>
1667
+ Use this attribute to specify the password that is required for authenticating with the server
1668
+
1669
+ -dxConnectPort <value>
1670
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1671
+
1672
+ -dxConnectUsername <value>
1673
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1674
+
1675
+ -dxConnectPassword <value>
1676
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1677
+
1678
+ -providerName <value>
1679
+ Use this attribute to specify the name of the Resource Environment Provider
1680
+
1681
+ -propertyName <value>
1682
+ Use this attribute to specify the name of the Custom Property
1683
+
1684
+ -propertyValue <value>
1685
+ Use this attribute to specify the value of the Custom Property
1686
+
1687
+ -propertyDesc <value>
1688
+ Use this attribute to specify the description of the Custom Property
1689
+ ```
1690
+
1691
+ **Required options for export properties Command options**
1692
+ ```
1693
+ -dxProtocol <value>
1694
+ Use this attribute to specify the protocol with which to connect to the server
1695
+
1696
+ -hostname <value>
1697
+ Use this attribute to specify the hostname of the target server
1698
+
1699
+ -dxConnectPort <value>
1700
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1701
+
1702
+ -dxConnectUsername <value>
1703
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1704
+
1705
+ -dxConnectPassword <value>
1706
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1707
+
1708
+ -dxWASUsername <value>
1709
+ Use this attribute to specify the username of the DX WAS server
1710
+
1711
+ -dxWASPassword <value>
1712
+ Use this attribute to specify the password of the DX WAS server
1713
+
1714
+ -dxProfileName <Profile name of the DX core server>
1715
+ Use this attribute to specify the profile name of the DX core server
1716
+ ```
1717
+
1718
+ **Required options for import properties Command options**
1719
+ ```
1720
+ -dxProtocol <value>
1721
+ Use this attribute to specify the protocol with which to connect to the server
1722
+
1723
+ -hostname <value>
1724
+ Use this attribute to specify the hostname of the target server
1725
+
1726
+ -dxConnectPort <value>
1727
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1728
+
1729
+ -dxConnectUsername <value>
1730
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1731
+
1732
+ -dxConnectPassword <value>
1733
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1734
+
1735
+ -dxWASUsername <value>
1736
+ Use this attribute to specify the username of the DX WAS server
1737
+
1738
+ -dxWASPassword <value>
1739
+ Use this attribute to specify the password of the DX WAS server
1740
+
1741
+ -dxProfileName <Profile name of the DX core server>
1742
+ Use this attribute to specify the profile name of the DX core server
1743
+
1744
+ -filePath <value>
1745
+ Use this attribute to specify the File path of the import Resource Environment Provider files.
1746
+ ```
1747
+
1748
+ Example Usage:
1749
+ ```
1750
+ dxclient resource-env-provider create-property -providerName <providerName> -propertyName <propertyName> -propertyValue <propertyValue>
1751
+
1752
+ dxclient resource-env-provider update-property -providerName <providerName> -propertyName <propertyName> -propertyValue <modifiedpropertyValue>
1753
+
1754
+ dxclient resource-env-provider delete-property -providerName <providerName> -propertyName <propertyName> -propertyValue <modifiedpropertyValue>
1755
+
1756
+ dxclient resource-env-provider export-properties -dxProfileName <dxProfileName>
1757
+
1758
+ dxclient resource-env-provider import-properties -dxProfileName <dxProfileName> -filePath <filePath>
1759
+
1760
+ dxclient resource-env-provider retrieve-property -providerName <providerName> -propertyName <propertyName>
1761
+ ```
1762
+
1763
+ ### 22. Manage virtual Portal
1764
+
1765
+ The `manage-virtual-portal` command is used to create, list ,export and import of virtual portal in the DX server.
1766
+
1767
+ Commands Description
1768
+ ```
1769
+ dxclient manage-virtual-portal
1770
+ ```
1771
+ **Help command**
1772
+ This command shows the help document on the `manage-virtual-portal` command:
1773
+ ```
1774
+ dxclient manage-virtual-portal create -h
1775
+
1776
+ dxclient manage-virtual-portal list -h
1777
+
1778
+ dxclient manage-virtual-portal import -h
1779
+
1780
+ dxclient manage-virtual-portal export -h
1781
+ ```
1782
+
1783
+ **Commands**
1784
+ ```
1785
+ manage-virtual-portal create [OPTIONS]
1786
+ Create virtual portal task in the DX server
1787
+
1788
+ manage-virtual-portal list [OPTIONS]
1789
+ List virtual portal task in the DX server
1790
+
1791
+ manage-virtual-portal import [OPTIONS]
1792
+ Import virtual portal task in the DX server
1793
+
1794
+ manage-virtual-portal export [OPTIONS]
1795
+ Export virtual portal task in the DX server
1796
+ ```
1797
+
1798
+ **Required options - `manage-virtual-portal create` command**
1799
+ ```
1800
+ -dxUsername <value>
1801
+ Use this attribute to specify the username that is required for authenticating with the server
1802
+
1803
+ -dxPassword <value>
1804
+ Use this attribute to specify the password that is required for authenticating with the server
1805
+
1806
+ -hostname <value>
1807
+ Use this attribute to specify the hostname of the target server
1808
+
1809
+ -dxConnectPort <value>
1810
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1811
+
1812
+ -dxConnectUsername <value>
1813
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1814
+
1815
+ -dxConnectPassword <value>
1816
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1817
+
1818
+ -dxProfileName <Profile name of the DX core server>
1819
+ Use this attribute to specify the profile name of the DX core server
1820
+
1821
+ -dxWASUsername <value>
1822
+ Use this attribute to specify the username of the DX WAS server
1823
+
1824
+ -dxWASPassword <value>
1825
+ Use this attribute to specify the password of the DX WAS server
1826
+
1827
+ -vpTitle <value>
1828
+ Use this attribute to specify the virtual portal Title
1829
+
1830
+ -vpRealm <value>
1831
+ Use this attribute to specify the virtual portal Realm
1832
+
1833
+ -vpAdminGroup <value>
1834
+ Use this attribute to specify the virtual portal AdminGroup
1835
+
1836
+ -vpHostname <value>
1837
+ Use this attribute to specify the virtual portal Hostname
1838
+
1839
+ -vpContext <value>
1840
+ Use this attribute to specify the virtual portal Context
1841
+
1842
+ Optional arguments:
1843
+ -requestId <Unique Id of a previously triggered create virtual portal request>
1844
+ Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1845
+ ```
1846
+
1847
+ Example Usage:
1848
+ ```
1849
+ dxclient manage-virtual-portal create -hostname <hostname> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxWASUsername < Username of the DX WAS server> -dxWASPassword <Password of the DX WAS server> -vpTitle <virtual-portal-Title> -vpRealm <virtual-portal-realm> -vpAdminGroup <virtual-portal-adminGroup> -vpHostname <virtual-portal-hostname> -vpContext <virtual-portal-context>
1850
+ ```
1851
+
1852
+ **Required options - `manage-virtual-portal list` command**
1853
+ ```
1854
+ -dxUsername <value>
1855
+ Use this attribute to specify the username that is required for authenticating with the server
1856
+
1857
+ -dxPassword <value>
1858
+ Use this attribute to specify the password that is required for authenticating with the server
1859
+
1860
+ -hostname <value>
1861
+ Use this attribute to specify the hostname of the target server
1862
+
1863
+ -dxConnectPort <value>
1864
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1865
+
1866
+ -dxConnectUsername <value>
1867
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
1868
+
1869
+ -dxConnectPassword <value>
1870
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
1871
+
1872
+ -dxProfileName <Profile name of the DX core server>
1873
+ Use this attribute to specify the profile name of the DX core server
1874
+
1875
+ -dxWASUsername <value>
1876
+ Use this attribute to specify the username of the DX WAS server
1877
+
1878
+ -dxWASPassword <value>
1879
+ Use this attribute to specify the password of the DX WAS server
1880
+ ```
1881
+
1882
+ Example Usage:
1883
+ ```
1884
+ dxclient manage-virtual-portal list -hostname <hostname> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <profile-name-of-the-DX-server> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxWASUsername <username-of-the-DX-WAS-server> -dxWASPassword <password-of-the-DX-WAS-server>
1885
+ ```
1886
+
1887
+ **Required options - `manage-virtual-portal import` command**
1888
+ ```
1889
+ -dxProtocol <value>
1890
+ Use this attribute to specify the protocol with which to connect to the server
1891
+
1892
+ -dxUsername <value>
1893
+ Use this attribute to specify the username that is required for authenticating with the server
1894
+
1895
+ -dxPassword <value>
1896
+ Use this attribute to specify the password that is required for authenticating with the server
1897
+
1898
+ -hostname <value>
1899
+ Use this attribute to specify the hostname of the target server
1900
+
1901
+ -dxPort <value>
1902
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1903
+
1904
+ -xmlConfigPath <value>
1905
+ Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config)
1906
+
1907
+ -xmlFile <value>
1908
+ Use this attribute to specify the xml file name with absolute path of the input file
1909
+
1910
+ -vpContext <value>
1911
+ Use this attribute to specify the virtual portal Context
1912
+ ```
1913
+
1914
+ Example Usage:
1915
+ ```
1916
+ dxclient manage-virtual-portal import -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -vpContext <virtual-portal-context>
1917
+ ```
1918
+
1919
+ **Required options - `manage-virtual-portal export` command**
1920
+ ```
1921
+ -dxProtocol <value>
1922
+ Use this attribute to specify the protocol with which to connect to the server
1923
+
1924
+ -dxUsername <value>
1925
+ Use this attribute to specify the username that is required for authenticating with the server
1926
+
1927
+ -dxPassword <value>
1928
+ Use this attribute to specify the password that is required for authenticating with the server
1929
+
1930
+ -hostname <value>
1931
+ Use this attribute to specify the hostname of the target server
1932
+
1933
+ -dxPort <value>
1934
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1935
+
1936
+ -xmlConfigPath <value>
1937
+ Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config)
1938
+
1939
+ -vpContext <value>
1940
+ Use this attribute to specify the virtual portal Context
1941
+
1942
+ -vpTitle <value>
1943
+ Use this attribute to specify the virtual portal Title
1944
+
1945
+ -xmlFile <value>
1946
+ Use this attribute to specify the xml file name with absolute path of the input file to export the virtual portal content.
1947
+ ```
1948
+ **Note:** Currently export virtual portal supports only vpContext and does not support vpHostname. Support for Virtual portal with hostname can be added in future release.
1949
+
1950
+ Example Usage:
1951
+ ```
1952
+ dxclient manage-virtual-portal export -hostname <hostname> -dxProtocol <dxProtocol> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -vpTitle <vpTitle> -vpContext <vpContext>
1953
+ ```
1954
+
1955
+ ### 23. Manage dam staging subscriber register
1956
+
1957
+ manage-dam-staging register-dam-subscriber command is used to register the subscriber for dam staging.
1958
+
1959
+ Commands Description
1960
+ ```
1961
+ dxclient manage-dam-staging register-dam-subscriber
1962
+ ```
1963
+ **Help command**
1964
+ This command shows the help information for `manage-dam-staging register-dam-subscriber` command usage:
1965
+ ```
1966
+ dxclient manage-dam-staging register-dam-subscriber -h
1967
+ ```
1968
+ **Command options**
1969
+ ```
1970
+ -dxProtocol, --dxProtocol <value>
1971
+ Protocol of the DX server of the publisher (default: "")
1972
+
1973
+ -hostname, --hostname <value>
1974
+ Host name of the DX server of the publisher (default: "")
1975
+
1976
+ -dxPort, --dxPort <value>
1977
+ Port number of the DX server of the publisher (default: "")
1978
+
1979
+ -dxUsername, --dxUsername <value>
1980
+ Username of the DX server of the publisher (default: "")
1981
+
1982
+ -dxPassword, --dxPassword <value>
1983
+ Password of the DX server of the publisher (default: "")
1984
+
1985
+ -targetServerUsername, --targetServerUsername <value>
1986
+ Username of the DX server of the subscriber (default: "")
1987
+
1988
+ -targetServerPassword, --targetServerPassword <value>
1989
+ Password of the DX server of the subscriber (default: "")
1990
+
1991
+ -damAPIPort, --damAPIPort <value>
1992
+ Port number of the DAM API server of the publisher (default: "")
1993
+
1994
+ -ringAPIPort, --ringAPIPort <value>
1995
+ Port number of the DX Core API server of the publisher (default: "")
1996
+
1997
+ -damAPIVersion, --damAPIVersion <value>
1998
+ API Version number of DAM API server of the publisher (default: "")
1999
+
2000
+ -ringAPIVersion, --ringAPIVersion <value>
2001
+ API Version number of DX Core API server of the publisher (default: "")
2002
+
2003
+ -targetHostname, --targetHostname <value>
2004
+ Host name of the target environment of the subscriber
2005
+
2006
+ -interval,--interval <value>
2007
+ Interval between two sync cycles. The unit of interval is minute. Default value of interval is 2 minutes.
2008
+ ```
2009
+ Example usage:
2010
+
2011
+ ```
2012
+ dxclient manage-dam-staging register-dam-subscriber -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -targetServerUsername <targetServerUsername> -targetServerPassword <targetServerPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname> -interval <interval>
2013
+
2014
+ ```
2015
+
2016
+ 24. Manage dam staging update secrets
2017
+
2018
+ manage-dam-staging update-secrets command is used to update publisher & subscriber secrets for dam staging.
2019
+
2020
+ Commands Description
2021
+ ```
2022
+ dxclient manage-dam-staging update-secrets
2023
+ ```
2024
+ **Help command**
2025
+ This command shows the help information for `manage-dam-staging update-secrets` command usage:
2026
+ ```
2027
+ dxclient manage-dam-staging update-secrets -h
2028
+ ```
2029
+ **Command options**
2030
+ ```
2031
+ -dxProtocol, --dxProtocol <value>
2032
+ Protocol of the DX server of the publisher (default: "")
2033
+
2034
+ -hostname, --hostname <value>
2035
+ Host name of the DX server of the publisher (default: "")
2036
+
2037
+ -dxPort, --dxPort <value>
2038
+ Port number of the DX server of the publisher (default: "")
2039
+
2040
+ -dxUsername, --dxUsername <value>
2041
+ Username of the DX server of the publisher (default: "")
2042
+
2043
+ -dxPassword, --dxPassword <value>
2044
+ Password of the DX server of the publisher (default: "")
2045
+
2046
+ -targetServerUsername, --targetServerUsername <value>
2047
+ Username of the DX server of the subscriber (default: "")
2048
+
2049
+ -targetServerPassword, --targetServerPassword <value>
2050
+ Password of the DX server of the subscriber (default: "")
2051
+
2052
+ -damAPIPort, --damAPIPort <value>
2053
+ Port number of the DAM API server of the publisher (default: "")
2054
+
2055
+ -ringAPIPort, --ringAPIPort <value>
2056
+ Port number of the DX Core API server of the publisher (default: "")
2057
+
2058
+ -damAPIVersion, --damAPIVersion <value>
2059
+ API Version number of DAM API server of the publisher (default: "")
2060
+
2061
+ -ringAPIVersion, --ringAPIVersion <value>
2062
+ API Version number of DX Core API server of the publisher (default: "")
2063
+
2064
+ -targetHostname, --targetHostname <value>
2065
+ Host name of the target environment of the subscriber
2066
+
2067
+ -interval,--interval <value>
2068
+ Interval between two sync cycles. The unit of interval is minute. Default value of interval is 2 minutes.
2069
+ ```
2070
+ Example usage:
2071
+ ```
2072
+ dxclient manage-dam-staging update-secrets -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -targetServerUsername <targetServerUsername> -targetServerPassword <targetServerPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname> -interval <interval>
2073
+ ```
2074
+
2075
+ ### 25. Manage dam staging trigger
2076
+
2077
+ manage-dam-staging trigger-staging command is used to trigger the DAM staging.
2078
+
2079
+ Commands Description
2080
+ ```
2081
+ dxclient manage-dam-staging trigger-staging
2082
+ ```
2083
+ **Help command**
2084
+ This command shows the help information for `manage-dam-staging trigger-staging` command usage:
2085
+ ```
2086
+ dxclient manage-dam-staging trigger-staging -h
2087
+ ```
2088
+ **Command options**
2089
+ ```
2090
+ -dxProtocol, --dxProtocol <value>
2091
+ Protocol of the DX server of the publisher (default: "")
2092
+
2093
+ -hostname, --hostname <value>
2094
+ Host name of the DX server of the publisher (default: "")
2095
+
2096
+ -dxPort, --dxPort <value>
2097
+ Port number of the DX server of the publisher (default: "")
2098
+
2099
+ -dxUsername, --dxUsername <value>
2100
+ Username of the DX server of the publisher (default: "")
2101
+
2102
+ -dxPassword, --dxPassword <value>
2103
+ Password of the DX server of the publisher (default: "")
2104
+
2105
+ -damAPIPort, --damAPIPort <value>
2106
+ Port number of the DAM API server of the publisher (default: "")
2107
+
2108
+ -ringAPIPort, --ringAPIPort <value>
2109
+ Port number of the DX Core API server of the publisher (default: "")
2110
+
2111
+ -damAPIVersion, --damAPIVersion <value>
2112
+ API Version number of DAM API server of the publisher (default: "")
2113
+
2114
+ -ringAPIVersion, --ringAPIVersion <value>
2115
+ API Version number of DX Core API server of the publisher (default: "")
2116
+
2117
+ -targetHostname, --targetHostname <value>
2118
+ Host name of the target environment of the subscriber
2119
+ ```
2120
+ Example usage:
2121
+
2122
+ ```
2123
+ dxclient manage-dam-staging trigger-staging -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname>
2124
+
2125
+ ```
2126
+
2127
+ ### 26. Manage dam staging subscriber deregister
2128
+
2129
+ manage-dam-staging deregister-dam-subscriber command is used to deregister subscriber.
2130
+
2131
+ Commands Description
2132
+ ```
2133
+ dxclient manage-dam-staging deregister-dam-subscriber
2134
+ ```
2135
+ **Help command**
2136
+ This command shows the help information for `manage-dam-staging deregister-dam-subscriber` command usage:
2137
+ ```
2138
+ dxclient manage-dam-staging deregister-dam-subscriber -h
2139
+ ```
2140
+ **Command options**
2141
+ ```
2142
+ -dxProtocol, --dxProtocol <value>
2143
+ Protocol of the DX server of the publisher (default: "")
2144
+
2145
+ -hostname, --hostname <value>
2146
+ Host name of the DX server of the publisher (default: "")
2147
+
2148
+ -dxPort, --dxPort <value>
2149
+ Port number of the DX server of the publisher (default: "")
2150
+
2151
+ -dxUsername, --dxUsername <value>
2152
+ Username of the DX server of the publisher (default: "")
2153
+
2154
+ -dxPassword, --dxPassword <value>
2155
+ Password of the DX server of the publisher (default: "")
2156
+
2157
+ -damAPIPort, --damAPIPort <value>
2158
+ Port number of the DAM API server of the publisher (default: "")
2159
+
2160
+ -ringAPIPort, --ringAPIPort <value>
2161
+ Port number of the DX Core API server of the publisher (default: "")
2162
+
2163
+ -damAPIVersion, --damAPIVersion <value>
2164
+ API Version number of DAM API server of the publisher (default: "")
2165
+
2166
+ -ringAPIVersion, --ringAPIVersion <value>
2167
+ API Version number of DX Core API server of the publisher (default: "")
2168
+
2169
+ -subscriberId, --subscriberId <value>
2170
+ Subscriber id of the target environment of the subscriber
2171
+ ```
2172
+ Example usage:
2173
+
2174
+ ```
2175
+ dxclient manage-dam-staging deregister-dam-subscriber -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
2176
+
2177
+ ```
2178
+
2179
+ ### 27. Create syndication relation
2180
+
2181
+ Create syndication relation command is used to create the relation between syndicator and subscriber in DX server.
2182
+
2183
+ Commands Description
2184
+ ```
2185
+ dxclient create-syndication-relation
2186
+ ```
2187
+ **Help command**
2188
+ This command shows the help information for `create-syndication-relation` command usage:
2189
+ ```
2190
+ dxclient create-syndication-relation -h
2191
+ ```
2192
+ **Command options**
2193
+ ```
2194
+ -dxProtocol, --dxProtocol <value>
2195
+ Protocol of the DX server (default: "")
2196
+
2197
+ -hostname, --hostname <value>
2198
+ Host name of the DX server (default: "")
2199
+
2200
+ -dxPort, --dxPort <value>
2201
+ Port number of the DX server, for any Kubernetes Environment default port is 443 (default: "")
2202
+
2203
+ -contenthandlerPath <value>
2204
+ The path to the contenthandler servlet on the Script Application server.
2205
+
2206
+ -dxUsername, --dxUsername <value>
2207
+ Username of the DX server (default: "")
2208
+
2209
+ -dxPassword, --dxPassword <value>
2210
+ Password of the DX Core (default: "")
2211
+
2212
+ -syndicatorUrl, --syndicatorUrl<value>
2213
+ Syndicator URL of target server e.g http(s)://host:port/wps/wcm
2214
+
2215
+ -syndicatorName, --syndicatorName <value>
2216
+ New syndicator name
2217
+
2218
+ -subscriberName, --subscriberName <value>
2219
+ New subscriber name
2220
+
2221
+ -vaultSlotName, --vaultSlotName <value>
2222
+ Credential Vault Name of source server
2223
+
2224
+ -isEnabled, --isEnabled <value>
2225
+ Whether the syndicator/subscriber pair is enabled on creation: isEnabled (default is true)
2226
+
2227
+ -updateAfterCreation, --updateAfterCreation <value>
2228
+ Whether the syndicator/subscriber pair is updateAfterCreation : updateAfterCreation (default is true)
2229
+
2230
+ -syndicationType, --syndicationType <value>
2231
+ The libraries to syndicate eg. all-items,liveItems,liveProjectsItem,all-items,published-items and all-items-and-versions.
2232
+ -webContentLibraries, --webContentLibraries <value>
2233
+ Libraries Name of target Server
2234
+
2235
+ -subscriberURL, --subscriberURL <value>
2236
+ Subscriber URL e.g http(s)://host:port/wps/wcm
2237
+
2238
+ -mode, --mode <value>
2239
+ Syndicator/subscriber mode
2240
+
2241
+ -syndicatorVaultSlotName, --syndicatorVaultSlotName <value>
2242
+ Credential Vault Name
2243
+
2244
+ -dxContextRoot, --dxContextRoot <value>
2245
+ Dx context root
2246
+
2247
+ -virtualPortalContext, --virtualPortalContext <value>
2248
+ Virtual portal Context
2249
+
2250
+ ```
2251
+ Example usage:
2252
+
2253
+ ```
2254
+ dxclient create-syndication-relation -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -syndicatorUrl <syndicatorUrl>
2255
+ -syndicatorName <syndicatorName> -subscriberName <subscriberName> -vaultSlotName <vaultSlotName>
2256
+ -isEnabled <isEnabled> -updateAfterCreation <updateAfterCreation> -syndicationType <syndicationType> -webContentLibraries <webContentLibraries> -subscriberURL <subscriberURL>
2257
+ -mode <mode> -syndicatorVaultSlotName <syndicatorVaultSlotName> -dxContextRoot <dxContextRoot>
2258
+ -virtualPortalContext <virtualPortalContext>
2259
+ ```
2260
+
2261
+ ### 28. Create Credential Vault
2262
+
2263
+ The `create-credential-vault` command is used to create or update a credential vault slot in the DX server.
2264
+
2265
+ Commands Description
2266
+ ```
2267
+ dxclient create-credential-vault
2268
+
2269
+ ```
2270
+ **Help command**
2271
+ This command shows the help document on the `create-credential-vault` command:
2272
+ ```
2273
+ dxclient create-credential-vault -h
2274
+ ```
2275
+ **Commands options**
2276
+ ```
2277
+ -hostname <value>
2278
+ Use this attribute to specify the hostname of the target server
2279
+
2280
+ -dxProtocol <value>
2281
+ Use this attribute to specify the protocol with which to connect to the server
2282
+
2283
+ -dxPort <value>
2284
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2285
+
2286
+ -xmlConfigPath <value>
2287
+ Use this attribute to specify the path to DX configuration endpoint
2288
+
2289
+ -dxUsername <value>
2290
+ Use this attribute to specify the username that is required for authenticating with the server
2291
+
2292
+ -dxPassword <value>
2293
+ Use this attribute to specify the password that is required for authenticating with the server
2294
+
2295
+ -credentialSlotName <value>
2296
+ Use this attribute to specify the credential vault segment slot name
2297
+
2298
+ -vaultUsername <value>
2299
+ Use this attribute to specify the credential vault vaultUsername
2300
+
2301
+ -vaultUserGroup <value>
2302
+ Use this attribute to specify the credential vault UserGroup
2303
+
2304
+ -vaultPassword <value>
2305
+ Use this attribute to specify the credential vault shared userid password
2306
+
2307
+ -vaultSegmentName <value>
2308
+ Use this attribute to specify the credential vault segment name and the default is set to "DefaultAdminSegment"
2309
+
2310
+ -vaultDescription <value>
2311
+ Use this attribute to specify the credential vault segment description
2312
+
2313
+ ```
2314
+
2315
+ Log files from command execution can be found in the logs directory of the DXClient installation.
2316
+
2317
+ Example Usage:
2318
+ ```
2319
+ dxclient create-credential-vault -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlConfigPath <xmlConfigPath> -credentialSlotName <credentialSlotName> -vaultUsername <vaultUsername> -vaultPassword <vaultPassword>
2320
+ ```
2321
+
2322
+ ### 29. WCM Libraries Export
2323
+
2324
+ The `wcm-library-export` command is used to export the wcm libraries from the source server to a user-specified location.
2325
+
2326
+ Commands Description
2327
+ ```
2328
+ dxclient wcm-library-export
2329
+
2330
+ ```
2331
+ **Help command**
2332
+ This command shows the help document on the `wcm-library-export` command:
2333
+ ```
2334
+ dxclient wcm-library-export -h
2335
+ ```
2336
+ **Commands options**
2337
+ ```
2338
+ -hostname <value>
2339
+ Use this attribute to specify the hostname of the target server
2340
+
2341
+ -dxUsername <value>
2342
+ Use this attribute to specify the username that is required for authenticating with the server
2343
+
2344
+ -dxPassword <value>
2345
+ Use this attribute to specify the password that is required for authenticating with the server
2346
+
2347
+ -dxConnectPort <value>
2348
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2349
+
2350
+ -dxConnectUsername <value>
2351
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
2352
+
2353
+ -dxConnectPassword <value>
2354
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
2355
+
2356
+ -dxWASUsername <value>
2357
+ Use this attribute to specify the username of the DX WAS server
2358
+
2359
+ -dxWASPassword <value>
2360
+ Use this attribute to specify the password of the DX WAS server
2361
+
2362
+ -dxProfileName <Profile name of the DX core server>
2363
+ Use this attribute to specify the profile name of the DX core server
2364
+
2365
+ -librariesName <value>
2366
+ Use this attribute to specify the names of the wcm libraries of the DX core server (e.g. "hello_library,demo_library")
2367
+
2368
+ -exportAllLibraries <value>
2369
+ Use this attribute to specify the export libraries. This value can be true or false. If true then export the all libraries
2370
+
2371
+ -virtualPortalContext <value>
2372
+ The context of the virtual portal from which wcm library should be exported.
2373
+
2374
+ ```
2375
+
2376
+ Log files from command execution can be found in the logs directory of the DXClient installation.
2377
+
2378
+ Example Usage:
2379
+ ```
2380
+ dxclient wcm-library-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxWASUsername <dxWASUsername> -dxProfileName <dxProfileName> -librariesName <librariesName>
2381
+ ```
2382
+
2383
+ ### 30. WCM Libraries Import
2384
+
2385
+ The `wcm-library-import` command is used to import the wcm libraries from the source server into the target server.
2386
+
2387
+ Commands Description
2388
+ ```
2389
+ dxclient wcm-library-import
2390
+
2391
+ ```
2392
+ **Help command**
2393
+ This command shows the help document on the `wcm-library-import` command:
2394
+
2395
+ ```
2396
+ dxclient wcm-library-import -h
2397
+ ```
2398
+ **Commands options**
2399
+ ```
2400
+ -hostname <value>
2401
+ Use this attribute to specify the hostname of the target server
2402
+
2403
+ -dxUsername <value>
2404
+ Use this attribute to specify the username that is required for authenticating with the server
2405
+
2406
+ -dxPassword <value>
2407
+ Use this attribute to specify the password that is required for authenticating with the server
2408
+
2409
+ -dxConnectPort <value>
2410
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2411
+
2412
+ -dxConnectUsername <value>
2413
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
2414
+
2415
+ -dxConnectPassword <value>
2416
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
2417
+
2418
+ -dxWASUsername <value>
2419
+ Use this attribute to specify the username of the DX WAS server
2420
+
2421
+ -dxWASPassword <value>
2422
+ Use this attribute to specify the password of the DX WAS server
2423
+
2424
+ -dxProfileName <Profile name of the DX core server>
2425
+ Use this attribute to specify the profile name of the DX core server
2426
+
2427
+ -libFilePath <value>
2428
+ Use this attribute to specify the path to a zip/tar containing wcm libraries in it
2429
+
2430
+ -virtualPortalContext <value>
2431
+ The context of the virtual portal to which wcm library should be imported.
2432
+
2433
+ ```
2434
+
2435
+ Log files from command execution can be found in the logs directory of the DXClient installation.
2436
+
2437
+ Example Usage:
2438
+ ```
2439
+ dxclient wcm-library-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxWASUsername <dxWASUsername> -dxProfileName <dxProfileName> -libFilePath <libFilePath>
2440
+ ```
2441
+ ### 31. DX Core Configuration Reports
2442
+
2443
+ The `dx-core-configuration-reports` command is used to generate the differential reports on various core configurations between two dx server nodes.
2444
+
2445
+ The dx-core-configuration-reports summary-report command shows the summary of the configurations of a single DX server or both source and target DX servers, which users may use to compare.
2446
+
2447
+ Command Description:
2448
+ ```
2449
+ dxclient dx-core-configuration-reports
2450
+ ```
2451
+ **Help command:**
2452
+ This command shows the help information for `dx-core-configuration-reports` command usage:
2453
+ ```
2454
+ dxclient dx-core-configuration-reports summary-report -h
2455
+ ```
2456
+ **Commands**
2457
+ ```
2458
+ dx-core-configuration-report summary-reports [OPTIONS]
2459
+ Provides a configurational report with differences for the source or target DX Core Servers.
2460
+ ```
2461
+ Command options: Summary report command
2462
+ ```
2463
+ -hostname <value>
2464
+ Use this attribute to specify the hostname of the DX Core server
2465
+
2466
+ -dxConnectPort <value>
2467
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2468
+
2469
+ -dxConnectUsername <value>
2470
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
2471
+
2472
+ -dxConnectPassword <value>
2473
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
2474
+
2475
+ -dxProfileName <Profile name of the DX core server>
2476
+ Use this attribute to specify the profile name of the DX core server
2477
+
2478
+ -targetHostname <value>
2479
+ Use this attribute to specify the hostname of the target DX core server
2480
+
2481
+ -targetDxConnectPort <value>
2482
+ Use this attribute to specify the port number of the target cw_profile server
2483
+
2484
+ -targetDxConnectUsername <value>
2485
+ Use this attribute to specify the username that is required for authenticating to the target cw_profile server
2486
+
2487
+ -targetDxConnectPassword<value>
2488
+ Use this attribute to specify the password that is required for authenticating to the target cw_profile server
2489
+
2490
+ -targetDxProfileName <Profile name of the DX core server>
2491
+ Use this attribute to specify the profile name of the target DX Core server
2492
+ ```
2493
+
2494
+ ```
2495
+ **Note:** target server details are only needed when the user needs to generate the summary of the configurations to both servers.
2496
+ ```
2497
+
2498
+ Example usage:
2499
+ ```
2500
+ dxclient dx-core-configuration-reports summary-report -hostname <hostname> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -dxProfileName <dxProfileName> -targetHostname <targetHostname> -targetDxConnectUsername <targetDxConnectUsername> -targetDxConnectPassword <targetDxConnectPassword> -targetDxConnectPort <targetDxConnectPort> -targetDxProfileName <targetDxProfileName>
2501
+ ```
2502
+
2503
+ ### 32. Export dam assets
2504
+
2505
+ The export command is used to export the assets of a dam in the file system at the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2506
+
2507
+ Commands Description
2508
+ ```
2509
+ dxclient manage-dam-assets export-assets
2510
+ ```
2511
+ **Help command**
2512
+ This command shows the help information for `manage-dam-assets` command usage:
2513
+ ```
2514
+ dxclient manage-dam-assets export-assets -h
2515
+ ```
2516
+ **Commands options**
2517
+ ```
2518
+ -dxProtocol <value>
2519
+ Use this attribute to specify the protocol with which to connect to the DX server
2520
+
2521
+ -hostname <value>
2522
+ Use this attribute to specify the hostname of the DX server
2523
+
2524
+ -dxPort <value>
2525
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2526
+
2527
+ -dxUsername <value>
2528
+ Use this attribute to specify the username that is required for authenticating with the server
2529
+
2530
+ -dxPassword <value>
2531
+ Use this attribute to specify the password that is required for authenticating with the server
2532
+
2533
+ -damAPIPort <value>
2534
+ Port number of the DAM server, for any Kubernetes Environment default port is 443 (default: "")
2535
+
2536
+ -ringAPIPort <value>
2537
+ Port number of the DX Core API server, for any Kubernetes Environment default port is 443 (default: "")
2538
+
2539
+ -ltpaTokenRefreshTime <value>
2540
+ LTPA Token Refresh time in minutes (default: "5")
2541
+
2542
+ -exportPath <value>
2543
+ Location of the file path to export(Default path is store/outputFiles/dam-export-assets/)
2544
+
2545
+ -exportBinary <value>
2546
+ Use true or false to include or exclude binary as part of export(default is true)
2547
+
2548
+ **Note:** Optional parameter are exportPath and exportBinary.
2549
+
2550
+ ```
2551
+
2552
+ Example Usage:
2553
+ ```
2554
+ dxclient manage-dam-assets export-assets -dxProtocol https -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -exportPath <exportPath> -exportBinary <exportBinary>
2555
+
2556
+ ```
2557
+
2558
+ ### 33. Validation of exported dam assets
2559
+ The valdiate command is used to validate exported DAM assets file at the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2560
+
2561
+ Commands Description
2562
+ ```
2563
+ dxclient manage-dam-assets validate-assets
2564
+ ```
2565
+ **Help command**
2566
+ This command shows the help information for `manage-dam-assets` command usage:
2567
+ ```
2568
+ dxclient manage-dam-assets validate-assets -h
2569
+ ```
2570
+ **Commands Optional options**
2571
+ ```
2572
+ -exportPath <value>
2573
+ Location of the file path to export(Default path is store/outputFiles/dam-export-assets/)
2574
+
2575
+ -importBinary <value>
2576
+ Use true or false to include or exclude binary as part of import(default is true)
2577
+
2578
+ **Note:** Optional parameter are exportPath and importBinary.
2579
+ ```
2580
+
2581
+ Example Usage:
2582
+ ```
2583
+ dxclient manage-dam-assets validate-assets -exportPath <exportPath> -importBinary <importBinary>
2584
+
2585
+ ```
2586
+
2587
+ ### 34. Import dam assets
2588
+
2589
+ The import command is used to import the assets of a dam to the target environment from the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2590
+
2591
+ Commands Description
2592
+ ```
2593
+ dxclient manage-dam-assets import-assets
2594
+ ```
2595
+ **Help command**
2596
+ This command shows the help information for `manage-dam-assets` command usage:
2597
+ ```
2598
+ dxclient manage-dam-assets import-assets -h
2599
+ ```
2600
+ **Commands options**
2601
+ ```
2602
+ -dxProtocol <value>
2603
+ Use this attribute to specify the protocol with which to connect to the DX server
2604
+
2605
+ -hostname <value>
2606
+ Use this attribute to specify the hostname of the DX server
2607
+
2608
+ -dxPort <value>
2609
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2610
+
2611
+ -dxUsername <value>
2612
+ Use this attribute to specify the username that is required for authenticating with the server
2613
+
2614
+ -dxPassword <value>
2615
+ Use this attribute to specify the password that is required for authenticating with the server
2616
+
2617
+ -damAPIPort <value>
2618
+ Port number of the DAM server, for any Kubernetes Environment default port is 443 (default: "")
2619
+
2620
+ -ringAPIPort <value>
2621
+ Port number of the DX Core API server, for any Kubernetes Environment default port is 443 (default: "")
2622
+
2623
+ -exportPath <value>
2624
+ Location of the file path to import(Default path is store/outputFiles/dam-export-assets/)
2625
+
2626
+ -importBinary <value>
2627
+ Use true or false to include or exclude binary as part of import(default is true)
2628
+
2629
+ **Note:** Optional parameter are exportPath and importBinary.
2630
+ ```
2631
+
2632
+ Example Usage:
2633
+ ```
2634
+ dxclient manage-dam-assets import-assets -dxProtocol https -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -exportPath <exportPath> -importBinary <importBinary>
2635
+ ```
2636
+
2637
+ ### 35. Manage dam staging get all subscribers
2638
+
2639
+ manage-dam-staging get-all-subscribers command is used to get all the subscribers details for dam staging.
2640
+
2641
+ Commands Description
2642
+ ```
2643
+ dxclient manage-dam-staging get-all-subscribers
2644
+ ```
2645
+ **Help command**
2646
+ This command shows the help information for `manage-dam-staging get-all-subscribers` command usage:
2647
+ ```
2648
+ dxclient manage-dam-staging get-all-subscribers -h
2649
+ ```
2650
+
2651
+ **Command options**
2652
+ ```
2653
+ -dxProtocol, --dxProtocol <value>
2654
+ Protocol of the DX server of the publisher (default: "")
2655
+
2656
+ -hostname, --hostname <value>
2657
+ Host name of the DX server of the publisher (default: "")
2658
+
2659
+ -dxPort, --dxPort <value>
2660
+ Port number of the DX server of the publisher (default: "")
2661
+
2662
+ -dxUsername, --dxUsername <value>
2663
+ Username of the DX server of the publisher (default: "")
2664
+
2665
+ -dxPassword, --dxPassword <value>
2666
+ Password of the DX server of the publisher (default: "")
2667
+
2668
+ -damAPIPort, --damAPIPort <value>
2669
+ Port number of the DAM API server of the publisher (default: "")
2670
+
2671
+ -ringAPIPort, --ringAPIPort <value>
2672
+ Port number of the DX Core API server of the publisher (default: "")
2673
+
2674
+ -damAPIVersion, --damAPIVersion <value>
2675
+ API Version number of DAM API server of the publisher (default: "")
2676
+
2677
+ -ringAPIVersion, --ringAPIVersion <value>
2678
+ API Version number of DX Core API server of the publisher (default: "")
2679
+ ```
2680
+
2681
+ Example usage:
2682
+ ```
2683
+ dxclient manage-dam-staging get-all-subscribers -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion>
2684
+
2685
+ ```
2686
+
2687
+ ### 36. Restart Core Pods
2688
+
2689
+ restart-core-pods command is used to restart all the Core Pods in a Kubernetes-based deployments.
2690
+
2691
+ Commands Description
2692
+ This command triggers a rollout restart for a Kubernetes-based deployments, similar to `kubectl rollout retstart` command.
2693
+
2694
+ Note: Only the user set as `wasAdmin` in the Helm values in authorised to trigger this command.
2695
+ ```
2696
+ dxclient restart-core-pods
2697
+ ```
2698
+
2699
+ **Help command**
2700
+ This command shows the help information for `restart-dx-core` command usage:
2701
+ ```
2702
+ dxclient restart-dx-core -h
2703
+ ```
2704
+ **Command options**
2705
+ ```
2706
+ -dxProtocol <value>
2707
+ Use this attribute to specify the protocol with which to connect to the server
2708
+
2709
+ -dxWASUsername <value>
2710
+ Use this attribute to specify the username that is required for authenticating with the DX WAS Server:
2711
+
2712
+ -dxWASPassword <value>
2713
+ Use this attribute to specify the password that is required for authenticating with the DX WAS Server:
2714
+
2715
+ -hostname <value>
2716
+ Use this attribute to specify the hostname of the target DX deployment:
2717
+ ```
2718
+
2719
+ ### 37. Undeploy Application
2720
+ undeploy-application command is used to undeploy an EAR file from the WebSphere Application Server.
2721
+
2722
+ Commands Description
2723
+ ```
2724
+ dxclient deploy-application
2725
+ This command undeploys the application from WAS. User could opt to store backup by setting 'enable-backup' parameter to true .
2726
+ ```
2727
+ **Help command**
2728
+ This command shows the help information for `undeploy-application` command usage:
2729
+ ```
2730
+ dxclient undeploy-application -h
2731
+ ```
2732
+
2733
+ **Common Command options**
2734
+ ```
2735
+ -hostname <value>
2736
+ Use this attribute to specify the hostname of the target server
2737
+
2738
+ -dxProtocol <value>
2739
+ Use this attribute to specify the protocol with which to connect to the server
2740
+
2741
+ -dxPort <value>
2742
+ Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2743
+
2744
+ -dxUsername <value>
2745
+ Use this attribute to specify the username that is required for authenticating with the server
2746
+
2747
+ -dxPassword <value>
2748
+ Use this attribute to specify the password that is required for authenticating with the server
2749
+
2750
+ Required options for application deployment:
2751
+
2752
+ -dxConnectPort <value>
2753
+ Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2754
+
2755
+ -dxConnectUsername <value>
2756
+ Use this attribute to specify the username that is required for authenticating to the cw_profile
2757
+
2758
+ -dxConnectPassword <value>
2759
+ Use this attribute to specify the password that is required for authenticating to the cw_profile
2760
+
2761
+ -dxSoapPort <Soap port of the DX server>
2762
+ Use this attribute to specify Soap port of the DX server
2763
+
2764
+ -dxProfileName <Profile name of the DX core server profile>
2765
+ Use this attribute to specify the profile name of the DX core server
2766
+
2767
+ -applicationName <value>
2768
+ Use this attribute to specify the application name
2769
+
2770
+ Optional arguments:
2771
+
2772
+ -enable-backup <value>
2773
+ Set the flag to true to take backup of the application to be undeployed. Default is false.
2774
+
2775
+ **Note:** Mandatory parameters applicationName should be passed into the command line.
2776
+ ```
2777
+ Example Usage:
2778
+ ```
2779
+ dxclient undeploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationName <application name> -dxProfileName <Profile name of the DX core server>
2780
+ ```
2781
+
2782
+ ### 38. LiveSync Push Theme
2783
+
2784
+ This command will sync your WebDAV based theme files into DX Server. Then, it will watch for succeeding changes within the given `themePath` and immediately reflect the changes in the DX Server.
2785
+
2786
+ Commands Description
2787
+
2788
+ This command initially pushes the local theme (provided in `themePath`) into DX Server with the theme system name (provided in `themeName`). During this initial synchronization, theme files in the WebDAV server are currently unavailable for other clients. It will then create a file system watcher which will watch for any changes (files or folders) under `themePath` and immediately reflect those changes in DX Server. To stop watching, press (Ctrl + C).
2789
+
2790
+ ```
2791
+ dxclient livesync push-theme
2792
+ ```
2793
+ **Help command**
2794
+ This command shows the help information for `live-sync` command usage:
2795
+ ```
2796
+ dxclient livesync push-theme -h
2797
+ ```
2798
+ **Command options**
2799
+ ```
2800
+ -dxProtocol, --dxProtocol <value>
2801
+ Protocol of the DX server
2802
+
2803
+ -hostname, --hostname <value>
2804
+ Host name of the DX server
2805
+
2806
+ -dxPort, --dxPort <value>
2807
+ Port number of the DX Server, for any Kubernetes Environment default port is 443
2808
+
2809
+ -dxUsername, --dxUsername <value>
2810
+ Username of the DX Core server
2811
+
2812
+ -dxPassword, --dxPassword <value>
2813
+ Password of the DX Core server
2814
+
2815
+ -contenthandlerPath,--contenthandlerPath <value>
2816
+ Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
2817
+
2818
+ -themeName, --themeName <value>
2819
+ Theme System Name
2820
+
2821
+ -themePath, --themePath <value>
2822
+ Local path to the Theme folder
2823
+
2824
+ -disablePrompt, --disablePrompt <value>
2825
+ Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
2826
+ ```
2827
+ Example usage:
2828
+
2829
+ ```
2830
+ dxclient livesync push-theme -dxUsername <dxUsername> -dxPassword <dxPassword> -dxPort <dxPort> -dxProtocol <dxProtocol> -hostname <hostname> -contenthandlerPath <contenthandlerPath> -themePath <themePath> -themeName <themeSystemName>
2831
+ ```
2832
+
2833
+ **Ignoring files and folders**
2834
+ You can opt to ignore files and folder paths to sync to server by creating an ignore file (`.ignore`) under the root of theme folder. When changing contents of the ignore file, the command needs to be re-run again to reflect the files the needs to be ignored.
2835
+
2836
+ Sample ignore file contents:
2837
+ ```
2838
+ #.ignore
2839
+
2840
+ test.txt
2841
+ sample.txt
2842
+ logs/
2843
+ ```
2844
+
2845
+ ### 39. LiveSync Pull Theme
2846
+
2847
+ The livesync pull-theme command is used to sync WebDAV based theme files from the DX server to a local folder.​
2848
+
2849
+ Commands Description
2850
+
2851
+ This command will download a zipped file from the theme server which then will be extracted to the chosen local directory of the theme (provided in `themePath`), overwriting existing files and deleting stale files in the process. If `themeName` option is not provided, a list of WebDAV themes are dislayed and user may select a theme to pull into their local.
2852
+
2853
+ ```
2854
+ dxclient livesync pull-theme
2855
+ ```
2856
+ **Help command**
2857
+ This command shows the help information for `livesync pull-theme` command usage:
2858
+ ```
2859
+ dxclient livesync pull-theme -h
2860
+ ```
2861
+
2862
+ **Command Options:**
2863
+ ```
2864
+ -dxProtocol, --dxProtocol <value>
2865
+ Protocol of the DX server
2866
+
2867
+ -hostname, --hostname <value>
2868
+ Host name of the DX server
2869
+
2870
+ -dxPort, --dxPort <value>
2871
+ Port number of the DX Server, for any Kubernetes Environment default port is 443
2872
+
2873
+ -dxUsername, --dxUsername <value>
2874
+ Username of the DX Core server
2875
+
2876
+ -dxPassword, --dxPassword <value>
2877
+ Password of the DX Core server
2878
+
2879
+ -contenthandlerPath,--contenthandlerPath <value>
2880
+ Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
2881
+
2882
+ -themeName, --themeName <value>
2883
+ Theme System Name
2884
+
2885
+ -themePath, --themePath <value>
2886
+ Local path to the Theme folder
2887
+
2888
+ -disablePrompt, --disablePrompt <value>
2889
+ Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
2890
+ ```
2891
+
2892
+ Example usage:
2893
+ ```
2894
+ dxclient livesync pull-theme --dxUsername <dxUsername> --dxPassword <dxPassword> --dxPort <dxPort> --dxProtocol <dxProtocol> --hostname <hostname> --contenthandlerPath <contenthandlerPath> --themePath <themePath> --themeSystemName <themeName>
2895
+ ```
2896
+
2897
+ ### 40. Manage dam staging get staging mismatch report
2898
+
2899
+ manage-dam-staging get-staging-mismatch-report command is used to generate staging mismatch report.
2900
+
2901
+ Commands Description
2902
+ ```
2903
+ dxclient manage-dam-staging get-staging-mismatch-report
2904
+ ```
2905
+ **Help command**
2906
+ This command shows the help information for `manage-dam-staging get-staging-mismatch-report` command usage:
2907
+ ```
2908
+ dxclient manage-dam-staging get-staging-mismatch-report -h
2909
+ ```
2910
+
2911
+ **Command options**
2912
+ ```
2913
+ -dxProtocol, --dxProtocol <value>
2914
+ Protocol of the DX server of the publisher (default: "")
2915
+
2916
+ -hostname, --hostname <value>
2917
+ Host name of the DX server of the publisher (default: "")
2918
+
2919
+ -dxPort, --dxPort <value>
2920
+ Port number of the DX server of the publisher (default: "")
2921
+
2922
+ -dxUsername, --dxUsername <value>
2923
+ Username of the DX server of the publisher (default: "")
2924
+
2925
+ -dxPassword, --dxPassword <value>
2926
+ Password of the DX server of the publisher (default: "")
2927
+
2928
+ -damAPIPort, --damAPIPort <value>
2929
+ Port number of the DAM API server of the publisher (default: "")
2930
+
2931
+ -ringAPIPort, --ringAPIPort <value>
2932
+ Port number of the DX Core API server of the publisher (default: "")
2933
+
2934
+ -damAPIVersion, --damAPIVersion <value>
2935
+ API Version number of DAM API server of the publisher (default: "")
2936
+
2937
+ -ringAPIVersion, --ringAPIVersion <value>
2938
+ API Version number of DX Core API server of the publisher (default: "")
2939
+
2940
+ -subscriberId, --subscriberId <value>
2941
+ Subscriber id of the target environment of the subscriber (default: "")
2942
+
2943
+ -recordType, --recordType <value>
2944
+ Type of the mismatch record (default: "")
2945
+
2946
+ -recordAction, --recordAction <value>
2947
+ Action of the mismatch record (default: "")
2948
+
2949
+ -reportPath, --reportPath <value>
2950
+ Location of the file path to download report (Default path is store/outputFiles/)
2951
+
2952
+ -ltpaTokenRefreshTime, --ltpaTokenRefreshTime <value>
2953
+ LTPA Token refresh time in minutes (default: 5)
2954
+ ```
2955
+
2956
+ Example usage:
2957
+ ```
2958
+ dxclient manage-dam-staging get-staging-mismatch-report -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId> -recordType <recordType> -recordAction <recordAction> -reportPath <reportPath> -ltpaTokenRefreshTime <ltpaTokenRefreshTime>
2959
+ ```
2960
+
2961
+ !!!warning
2962
+ 1. Avoid using `~` `!` `()` `'` and `*` special characters when naming files and folders.
2963
+ 2. If you have a theme title name with special characters, those are automatically converted to underscores (`_`) by the server (for example, `来源folder` is translated to `__folder`). For the theme name, use the Theme System Name, the one with `_` like `__folder` in the following example.
2964
+
2965
+ ### 41. Manage dam staging find staging mismatch
2966
+
2967
+ manage-dam-staging find-staging-mismatch command is used to get mismatch logs for dam staging.
2968
+
2969
+ Commands Description
2970
+ ```
2971
+ dxclient manage-dam-staging find-staging-mismatch
2972
+ ```
2973
+ **Help command**
2974
+ This command shows the help information for `manage-dam-staging find-staging-mismatch` command usage:
2975
+ ```
2976
+ dxclient manage-dam-staging find-staging-mismatch -h
2977
+ ```
2978
+
2979
+ **Command options**
2980
+ ```
2981
+ -dxProtocol, --dxProtocol <value>
2982
+ Protocol of the DX server of the publisher (default: "")
2983
+
2984
+ -hostname, --hostname <value>
2985
+ Host name of the DX server of the publisher (default: "")
2986
+
2987
+ -dxPort, --dxPort <value>
2988
+ Port number of the DX server of the publisher (default: "")
2989
+
2990
+ -dxUsername, --dxUsername <value>
2991
+ Username of the DX server of the publisher (default: "")
2992
+
2993
+ -dxPassword, --dxPassword <value>
2994
+ Password of the DX server of the publisher (default: "")
2995
+
2996
+ -damAPIPort, --damAPIPort <value>
2997
+ Port number of the DAM API server of the publisher (default: "")
2998
+
2999
+ -ringAPIPort, --ringAPIPort <value>
3000
+ Port number of the DX Core API server of the publisher (default: "")
3001
+
3002
+ -damAPIVersion, --damAPIVersion <value>
3003
+ API Version number of DAM API server of the publisher (default: "")
3004
+
3005
+ -ringAPIVersion, --ringAPIVersion <value>
3006
+ API Version number of DX Core API server of the publisher (default: "")
3007
+
3008
+ -subscriberId, --subscriberId <value>
3009
+ Subscriber id of the target environment of the subscriber
3010
+ ```
3011
+
3012
+ Example usage:
3013
+ ```
3014
+ dxclient manage-dam-staging find-staging-mismatch -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3015
+ ```
3016
+
3017
+ ### 42. Manage dam staging start staging resync
3018
+
3019
+ manage-dam-staging start-staging-resync command is used to trigger staging resync.
3020
+
3021
+ Commands Description
3022
+ ```
3023
+ dxclient manage-dam-staging start-staging-resync
3024
+ ```
3025
+ **Help command**
3026
+ This command shows the help information for `manage-dam-staging start-staging-resync` command usage:
3027
+ ```
3028
+ dxclient manage-dam-staging start-staging-resync -h
3029
+ ```
3030
+
3031
+ **Command options**
3032
+ ```
3033
+ -dxProtocol, --dxProtocol <value>
3034
+ Protocol of the DX server of the publisher (default: "")
3035
+
3036
+ -hostname, --hostname <value>
3037
+ Host name of the DX server of the publisher (default: "")
3038
+
3039
+ -dxPort, --dxPort <value>
3040
+ Port number of the DX server of the publisher (default: "")
3041
+
3042
+ -dxUsername, --dxUsername <value>
3043
+ Username of the DX server of the publisher (default: "")
3044
+
3045
+ -dxPassword, --dxPassword <value>
3046
+ Password of the DX server of the publisher (default: "")
3047
+
3048
+ -damAPIPort, --damAPIPort <value>
3049
+ Port number of the DAM API server of the publisher (default: "")
3050
+
3051
+ -ringAPIPort, --ringAPIPort <value>
3052
+ Port number of the DX Core API server of the publisher (default: "")
3053
+
3054
+ -damAPIVersion, --damAPIVersion <value>
3055
+ API Version number of DAM API server of the publisher (default: "")
3056
+
3057
+ -ringAPIVersion, --ringAPIVersion <value>
3058
+ API Version number of DX Core API server of the publisher (default: "")
3059
+
3060
+ -subscriberId, --subscriberId <value>
3061
+ Subscriber id of the target environment of the subscriber
3062
+ ```
3063
+
3064
+ Example usage:
3065
+ ```
3066
+ dxclient manage-dam-staging start-staging-resync -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3067
+ ```
3068
+
3069
+ ### 43. Manage dam staging delete staging mismatch
3070
+
3071
+ manage-dam-staging delete-staging-mismatch command is used to delete mismatch logs for all the registered dam staging subscribers.
3072
+
3073
+ Commands Description
3074
+ ```
3075
+ dxclient manage-dam-staging delete-staging-mismatch
3076
+ ```
3077
+ **Help command**
3078
+ This command shows the help information for `manage-dam-staging delete-staging-mismatch` command usage:
3079
+ ```
3080
+ dxclient manage-dam-staging delete-staging-mismatch -h
3081
+ ```
3082
+
3083
+ **Command options**
3084
+ ```
3085
+ -dxProtocol, --dxProtocol <value>
3086
+ Protocol of the DX server of the publisher (default: "")
3087
+
3088
+ -hostname, --hostname <value>
3089
+ Host name of the DX server of the publisher (default: "")
3090
+
3091
+ -dxPort, --dxPort <value>
3092
+ Port number of the DX server of the publisher (default: "")
3093
+
3094
+ -dxUsername, --dxUsername <value>
3095
+ Username of the DX server of the publisher (default: "")
3096
+
3097
+ -dxPassword, --dxPassword <value>
3098
+ Password of the DX server of the publisher (default: "")
3099
+
3100
+ -damAPIPort, --damAPIPort <value>
3101
+ Port number of the DAM API server of the publisher (default: "")
3102
+
3103
+ -ringAPIPort, --ringAPIPort <value>
3104
+ Port number of the DX Core API server of the publisher (default: "")
3105
+
3106
+ -damAPIVersion, --damAPIVersion <value>
3107
+ API Version number of DAM API server of the publisher (default: "")
3108
+
3109
+ -ringAPIVersion, --ringAPIVersion <value>
3110
+ API Version number of DX Core API server of the publisher (default: "")
3111
+
3112
+ -subscriberId, --subscriberId <value>
3113
+ Subscriber id of the target environment of the subscriber (default: "")
3114
+ ```
3115
+
3116
+ ```
3117
+ **Note:** The "subscriberId" is required only when a user intends to delete mismatch logs for a particular subscriber.
3118
+ ```
3119
+
3120
+ Example usage:
3121
+ ```
3122
+ dxclient manage-dam-staging find-staging-mismatch -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3123
+ ```
3124
+
3125
+ # Logger enablement
3126
+
3127
+ ## Enable logger
3128
+
3129
+ Logger can be enabled by setting parameter "enableLogger": true in the below file. If logger enabled then logger file will be generate in logs folder of the dxclient.
3130
+
3131
+ dist/configuration/config.json
3132
+
3133
+ If logger enabled then logger file will be available in the below location:
3134
+ store/logs/
3135
+
3136
+ ## disable logger
3137
+
3138
+ Logger can be disabled by setting parameter "enableLogger":false in the below file
3139
+
3140
+ dist/configuration/config.json
3141
+
3142
+ All the generic command options can be configured inside “config.json” of the tool, which will be read as default.
3143
+ The options passed through command line will override these default values.