{"id":6565,"date":"2019-09-18T06:55:50","date_gmt":"2019-09-18T06:55:50","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=6565"},"modified":"2021-11-16T10:11:16","modified_gmt":"2021-11-16T10:11:16","slug":"working-with-udeploy-client-using-udclient-and-work-with-udeploy-command-line","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/working-with-udeploy-client-using-udclient-and-work-with-udeploy-command-line\/","title":{"rendered":"Working with uDeploy client using udclient and work with uDeploy command line"},"content":{"rendered":"\n

Step 1 – Install and setup JAVA including JAVA_HOME <\/strong><\/p>\n\n\n

$ sudo -s\n$ yum install wget -y\n$ wget -c --header \"Cookie: oraclelicense=accept-securebackup-cookie\"<\/span> http:\/\/download.oracle.com\/otn-pub\/java\/jdk\/8u131-b11\/d54c1d3a095b4ff2b6607d096fa80163\/jdk-8u131-linux-x64.rpm<\/span>\n$ rpm -ivh jdk-8<\/span>u131-linux-x64.rpm\n$ java -version\n$ export<\/span> JAVA_HOME=\/usr\/<\/span>java\/jdk1.8<\/span>.0<\/span>_131<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Step 2  – Click the link to download the Deploy Client zip. This zip contains the command line executable for use with IBM UrbanCode Deploy. such as https:\/\/52.66.112.139:8443\/#tools<\/strong><\/p>\n\n\n
$ cd \/opt\/\n$ mkdir cli\n$ cd cli\/\n$ wget --no-check-certificate https:\/\/52.66.112.139:8443\/tools\/udclient.zip<\/span>\n$ unzip udclient.zip\n$ cd udclient<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n
[root@rajesh-udeploy-server udclient]# .\/udclient<\/span>\nGlobal<\/span> Args:\n         -authtoken, --authtoken\n            Optional. Can be set via the environment variable DS_AUTH_TOKEN. An\n            authentication token generated by the server. Either an authtoken or<\/span>\n            a username and<\/span> password is required\n         -loggingConf, --loggingConf\n            Optional. Can be set via the environment variable loggingConf. A\n            properties file for<\/span> custom log4j configuration. Overrides debug and<\/span>\n            debugHttp flags.\n         -password, --password\n            Optional. Can be set via the environment variable DS_PASSWORD. A\n            password to authenticate with the server. Either an authtoken or<\/span> a\n            username and<\/span> password is required\n         -proxyHost, --proxyHost\n            Optional. Can be set via the environment variable proxyHost. The\n            hostname of a proxy (e.g., an agent relay) to use<\/span> instead<\/span> of<\/span>\n            directly<\/span> connecting<\/span> to<\/span> the<\/span> server<\/span>\n         -proxyPassword<\/span>, --proxyPassword<\/span>\n            Optional<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span> proxyPassword<\/span>. A<\/span>\n            password<\/span> to<\/span> authenticate<\/span> with<\/span> the<\/span> proxy<\/span>.\n         -proxyPort<\/span>, --proxyPort<\/span>\n            Optional<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span> proxyPort<\/span>. The<\/span>\n            proxy<\/span> port<\/span> to<\/span> use<\/span> if<\/span> a<\/span> proxy<\/span> hostname<\/span> has<\/span> been<\/span> specified<\/span>\n         -proxyUser<\/span>, --proxyUser<\/span>\n            Optional<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span> proxyUser<\/span>. A<\/span>\n            username<\/span> to<\/span> authenticate<\/span> with<\/span> the<\/span> proxy<\/span>.\n         -username<\/span>, --username<\/span>\n            Optional<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span> DS_USERNAME<\/span>. A<\/span>\n            username<\/span> to<\/span> authenticate<\/span> with<\/span> the<\/span> server<\/span>. Either<\/span> an<\/span> authtoken<\/span> or<\/span> a<\/span>\n            username<\/span> and<\/span> password<\/span> is<\/span> required<\/span>\n         -verifyServerIdentity<\/span>, --verifyServerIdentity<\/span>\n            Optional<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span>\n            UC_TLS_VERIFY_CERTS<\/span>. This<\/span> option<\/span> will<\/span> only<\/span> allow<\/span> the<\/span> command<\/span> to<\/span>\n            complete<\/span> if<\/span> the<\/span> server<\/span>'s<\/span> certificate<\/span> is<\/span> trusted<\/span>. (Default<\/span> Value<\/span>:\n            false<\/span>)\n         -weburl<\/span>, --weburl<\/span>\n            Required<\/span>. Can<\/span> be<\/span> set<\/span> via<\/span> the<\/span> environment<\/span> variable<\/span> DS_WEB_URL<\/span>. The<\/span>\n            base<\/span> URL<\/span> of<\/span> the<\/span> IBM<\/span> UrbanCode<\/span> Deploy<\/span> server<\/span>. Eg<\/span>.\n            http<\/span>:\/\/ibm<\/span>-ucd<\/span>.domain<\/span>.com<\/span>:8080\n\nGlobal<\/span> Flags<\/span>:\n         -t<\/span>, --getTemplate<\/span>\n            Show<\/span> the<\/span> JSON<\/span> template<\/span> for<\/span> the<\/span> command<\/span> instead<\/span> of<\/span> running<\/span> the<\/span>\n            command<\/span>. If<\/span> a<\/span> file<\/span> argument<\/span> is<\/span> provided<\/span>, the<\/span> template<\/span> will<\/span> be<\/span> output<\/span>\n            to<\/span> that<\/span> file<\/span>.\n         -h<\/span>, --help<\/span>\n            Print<\/span> the<\/span> full<\/span> description<\/span> and<\/span> help<\/span> of<\/span> the<\/span> given<\/span> command<\/span> instead<\/span> of<\/span>\n            running<\/span> the<\/span> command<\/span>.\n         -v<\/span>, --verbose<\/span>\n            Print<\/span> extra<\/span> information<\/span> during<\/span> execution<\/span>.\n         --debug<\/span>\n            Print<\/span> debugging<\/span> information<\/span> during<\/span> execution<\/span>. Implies<\/span> verbose<\/span>.\n         --debugHttp<\/span>\n            Print<\/span> detailed<\/span> HTTP<\/span> debugging<\/span> information<\/span> during<\/span> execution<\/span>.\nCommands<\/span>:\n         Provide<\/span> a<\/span> web<\/span> URL<\/span>, username<\/span>, and<\/span> password<\/span> to<\/span> show<\/span> all<\/span> available<\/span> commands<\/span>.<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Example Programs<\/strong><\/p>\n\n\n
\n$ .\/udclient -weburl https:\/\/52.66.112.139:8443 -authtoken 815123a9-a76a-45a1-9c26-6a9411dd3ef5<\/span>\n$ .\/udclient -weburl https:\/\/52.66.112.139:8443 -authtoken 815123a9-a76a-45a1-9c26-6a9411dd3ef5 createGroup -group group1 -authorizationRealm \"Internal Security\"<\/span>\n$ .\/udclient -weburl https:\/\/52.66.112.139:8443 -authtoken 815123a9-a76a-45a1-9c26-6a9411dd3ef5 createUser newUser.json<\/span>\n\nvi newUser.json\n--------------------------\n{\n  \"name\"<\/span>: \"rajesh\"<\/span>,\n  \"password\"<\/span>: \"password\"<\/span>,\n  \"actualName\"<\/span>: \"Jane Smith\"<\/span>,\n  \"email\"<\/span>: \"devops@rajeshkumar.xyz\"<\/span>,\n  \"authenticationRealm\"<\/span>: \"Internal Security\"<\/span>\n}\n\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Reference<\/strong>
https:\/\/www.ibm.com\/support\/knowledgecenter\/SS4GSP_6.2.4\/com.ibm.udeploy.reference.doc\/topics\/cli_commands.html<\/p>\n\n\n\n
Commands:<\/p>\n\n\n
  addAgentPoolToTeam\n  addAgentToPool\n  addAgentToTeam\n  addApplicationToTeam\n  addComponentTemplateToTeam\n  addComponentToApplication\n  addComponentToTeam\n  addEnvironmentBaseResource\n  addEnvironmentProperty\n  addEnvironmentToTeam\n  addGroupToTeam\n  addProcessToTeam\n  addResourceToTeam\n  addStatusToSnapshot\n  addTagToAgent\n  addTagToApplication\n  addTagToComponent\n  addTagToResource\n  addUserToGroup\n  addUserToTeam\n  addVersionFiles\n  addVersionLink\n  addVersionStatus\n  addVersionToSnapshot\n  archiveVersion\n  cancelWorkflow\n  closeTask\n  copyResource\n  copyVersion\n  createAgentPool\n  createApplication\n  createApplicationFromTemplate\n  createApplicationProcess\n  createAuthToken\n  createBlueprintDesignerIntegration\n  createComponent\n  createComponentProcess\n  createComponentTemplate\n  createEnvironment\n  createEnvironmentFromTemplate\n  createGenericProcess\n  createGroup\n  createManyVersions\n  createResource\n  createResourceTemplate\n  createSnapshot\n  createSnapshotOfEnvironment\n  createStatus\n  createTeam\n  createUser\n  createVersion\n  createZOSVersion\n  deleteAgent\n  deleteAgentPool\n  deleteAgentProperty\n  deleteAllDesiredInventoryVersions\n  deleteBlueprintDesignerIntegration\n  deleteComponentVersionPropDef\n  deleteEnvironment\n  deleteGroup\n  deleteRedundantDesiredInventoryVersions\n  deleteResource\n  deleteResourceProperty\n  deleteSnapshot\n  deleteStatus\n  deleteTeam\n  deleteUser\n  deleteVersion\n  downloadVersionArtifacts\n  exportDetailedGroup\n  exportGroup\n  forceRenameAgent\n  getAgent\n  getAgentPool\n  getAgentPools\n  getAgentProperty\n  getAgentPrototypes\n  getAgentStatuses\n  getAgents\n  getAllApplicationProcessesForApplication\n  getAllTeams\n  getAllUsersInRoleForTeam\n  getAllUsersWithEmail\n  getApplication\n  getApplicationProcess\n  getApplicationProcessExecution\n  getApplicationProcessRequest\n  getApplicationProcessRequestStatus\n  getApplicationProcessUnfilledProperties\n  getApplicationProperties\n  getApplicationProperty\n  getApplications\n  getApplicationsProcessRequests\n  getApplicationsProcessRequestsCount\n  getApprovalTasks\n  getBlueprintNodePropertiesTemplate\n  getBlueprintsInApplication\n  getComponent\n  getComponentEnvironmentProperties\n  getComponentProcess\n  getComponentProcessRequest\n  getComponentProcessRequestCount\n  getComponentProcessRequests\n  getComponentProperties\n  getComponentProperty\n  getComponentTemplates\n  getComponentVersionPropDefs\n  getComponentVersions\n  getComponents\n  getComponentsInApplication\n  getEnvironment\n  getEnvironmentBaseResources\n  getEnvironmentProperties\n  getEnvironmentProperty\n  getEnvironmentsInApplication\n  getFirstUserWithEmail\n  getHighWatermarks\n  getLatestSnapshotForEnvironment\n  getOverlappingArtifacts\n  getRelayStatuses\n  getRelays\n  getResource\n  getResourceProperties\n  getResourceProperty\n  getResourceTemplate\n  getResourceTemplateChildren\n  getResources\n  getResourcesWithComponentVersion\n  getSnapshot\n  getSnapshotConfiguration\n  getSnapshotVersions\n  getSnapshotsInApplication\n  getStatus\n  getStatusList\n  getStatuses\n  getSystemConfiguration\n  getSystemProperties\n  getSystemProperty\n  getTagsOnAgent\n  getTagsOnApplication\n  getTagsOnComponent\n  getTagsOnResource\n  getTeam\n  getUser\n  getUserByEmail\n  getVersionId\n  getVersionLink\n  getVersionLinks\n  getVersionProperties\n  importGroup\n  importLdapUser\n  importVersions\n  installAgent\n  listArtifacts\n  lockSnapshotConfiguration\n  lockSnapshotVersions\n  login\n  logout\n  moveResource\n  provisionEnvironment\n  removeAgentFromPool\n  removeAgentFromTeam\n  removeAgentPoolFromTeam\n  removeApplicationFromTeam\n  removeComponentFromTeam\n  removeComponentTemplateFromTeam\n  removeEnvironmentBaseResource\n  removeEnvironmentFromTeam\n  removeEnvironmentProperty\n  removeProcessFromTeam\n  removeResourceFromTeam\n  removeTagFromAgent\n  removeTagFromApplication\n  removeTagFromComponent\n  removeTagFromResource\n  removeUserFromGroup\n  removeVersionFromSnapshot\n  removeVersionLink\n  removeVersionStatus\n  repeatApplicationProcessRequest\n  requestApplicationProcess\n  restartAgent\n  setAgentProperty\n  setApplicationProperty\n  setComponentEnvironmentProperty\n  setComponentProperty\n  setComponentVersionPropDef\n  setEnvironmentProperty\n  setResourceProperty\n  setSystemConfiguration\n  setSystemProperty\n  setVersionProperty\n  shutdownAgent\n  testAgent\n  updateResource\n  updateResourceTemplate\n  updateTeam\n  updateUser\n  upgradeAgent<\/code><\/span><\/pre>\n\n