OpenDeploy_16.3_Reference_Guide_en_rev1.pdf - OpenDeploy Reference Guide Release 16.3 TM OpenText TeamSite OpenDeploy Reference Guide Rev October 2017

OpenDeploy_16.3_Reference_Guide_en_rev1.pdf - OpenDeploy...

This preview shows page 1 out of 309 pages.

Unformatted text preview: OpenDeploy Reference Guide Release 16.3 TM OpenText TeamSite OpenDeploy Reference Guide Rev.: October 2017 This documentation has been created for software version 16.3. It is also valid for subsequent software versions as long as no new document version is shipped with the product or is published at . Open Text Corporation 275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1 Tel: +1-519-888-7111 Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440 Fax: +1-519-888-0677 Support: For more information, visit Copyright © 2017 Open Text. All Rights Reserved. Trademarks owned by Open Text. Disclaimer No Warranties and Limitation of Liability Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However, Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the accuracy of this publication. Table of Contents Chapter 1 Command-Line Tools iwodauthorize 17 17 Usage 17 Examples 19 iwodcmd 20 Usage 20 iwoddeploycancel Usage iwodinsttool Usage iwodkeystoreaddcert 26 26 27 27 27 Usage 27 Examples 28 iwodkeystorecreatecert 28 Usage 28 Examples 28 iwodkeystoreexportcert 29 Usage 29 Examples 29 iwodkeystorelist 29 Usage 29 Examples 30 iwodnetcache 30 Usage iwodnonroot Usage 30 30 31 3 iwodpasscoder Usage iwodpassencrypter Usage iwodschedactivate Usage iwodschedadd Usage iwodscheddelete Usage iwodschedget Usage iwodservergetversion Usage iwodserverreset Usage iwodserverstatus 31 31 31 31 32 32 33 33 33 34 34 35 35 35 36 36 Usage 36 iwodstart 37 Usage 37 iwodsubscribereceiver 37 Usage 38 iwsyncdb 41 General Usage 41 UDS Usage 41 Wide-Table Usage (Legacy Support) 45 Multiple Instances 47 Configuration File Requirements 47 Chapter 2 OpenDeploy Ports 49 Base Server and Receiver Ports 50 Administration/Reporting Server Ports 55 Chapter 3 Deploy Server Configuration DTD Deploy Server Configuration DTD 4 31 59 59 Descriptions of Elements and Attributes 68 deployServerConfiguration 68 localNode 69 initiatorProperties 71 serializeDeploymentByTime 72 serializeDeploymentByRandom 72 listenerProperties 73 transportProperties 74 payLoadProperties 74 dnrProperties 75 allowedDnrs 76 dnrCmd 76 eventReporting 77 databaseDeployment 77 standalone 78 das 79 webServices 79 httpTransport 80 httpsTransport 80 webServiceTransport 81 schedulerProperties 81 allowedHosts 82 node 83 allowedDirectories 83 path 83 logRules 84 remoteActionProperties 85 action 86 upgradeBitsMap 87 alias 87 thresholdProperties 88 disk 88 path 88 5 deploymentLegs 89 allowedEventReportingHost 89 Chapter 4 Receiver Deploy Server Configuration DTD Receiver Deploy Server Configuration DTD 90 Descriptions of Elements and Attributes 94 deployServerConfiguration 94 localNode 95 listenerProperties 96 transportProperties 98 dnrProperties 98 allowedHosts 99 node 99 allowedDirectories 100 path 100 logRules 100 eventReporting 102 webServices 102 httpTransport 103 httpsTransport 103 webServiceTransport 104 remoteActionProperties 105 action 105 databaseDeployment 106 standalone 107 thresholdProperties 107 disk 107 path 108 deploymentLegs 108 Chapter 5 Nodes Configuration DTD 6 90 109 Nodes Configuration DTD 109 Descriptions of Elements and Attributes 110 nodeSet 110 node 110 routeDefinition 111 nodeInfo 111 Chapter 6 SNMP Agent Configuration DTD 113 SNMP Agent Configuration DTD 113 Descriptions of Elements and Attributes 114 snmpAgentConfiguration 114 agentProperties 115 securityProperties 116 node 116 alertList 117 alert 117 Chapter 7 Deployment Configuration DTD 118 Deployment Configuration DTD 118 Descriptions of Elements and Attributes 123 deploymentConfiguration 123 localNode 124 transportProperties 126 definition 126 deployment 127 routedDeployment 127 dnrDeploymentJob 128 execDeploymentTask 129 getInfo 129 request 130 remoteAction 131 requestAction 131 actionParameters 132 source 133 target 133 reverseSource 133 reverseTarget 134 dataDeploy 134 deployNRun 134 7 dnrFile 135 dnrDir 136 dnrDeployment 136 script 137 logRules 138 nodeRef 139 nextDeployment 140 replicationFarmSet 141 replicationFarm 141 Chapter 8 Deployment Source DTD 8 142 Deployment Source DTD 142 Descriptions of Elements and Attributes 148 source 148 sourceFilesystem 148 sourceTeamsite 149 iwStore 150 fileSystem 151 remoteDiff 151 areaDiff 152 filelist 152 payload 153 payLoadRules 154 payLoadProperties 155 custom 156 query 156 action 156 pathSpecification 157 targetRules 157 path 158 filters 159 includePath 159 includePattern 160 excludePath 160 excludePattern 161 exceptPath 161 exceptPattern 162 comparisonRules 162 transferRules 164 sourceTransferRules 165 permissionRules 166 userTranslation 168 groupTranslation 168 dbLoader 169 eaAndXmlData 169 xmlData 170 eaData 170 dbLoaderCustom 171 Chapter 9 Target Configuration DTD 173 Target Configuration DTD 173 Descriptions of Elements and Attributes 174 target 174 targetFilesystem 175 targetTeamsite 175 odAdapterSet 176 odAdapter 176 replicationFarmLink 178 internal 178 external 178 Chapter 10 DataDeploy DTD 179 The DataDeploy DTD 179 Descriptions of Elements and Attributes 187 data-deploy-configuration 187 data-deploy-elements 188 external-tuple-processor 188 server 189 allowed-hosts 189 9 10 host 189 bind 190 for-deployment 190 client 191 deployment 191 source 192 exec-deployment 192 destinations 192 teamsite-templating-records 193 path 195 xml-formatted-data 195 fields 196 field 196 xml-source 197 teamsite-extended-attributes 202 database 203 stored-procedure 210 fieldname 210 trigger 210 search 211 select 211 update 211 db-producer-query 212 sql 212 dbschema 213 group 214 attrmap 215 column 215 keys 217 primary-key 217 key-column 218 foreign-key 218 column-pair 218 create-sql 219 exists-sql 219 event-subsystem 220 jmsserver 220 jmsproperties 221 jndiproperties 221 property 221 file 222 filter 222 keep 222 discard 223 and 223 or 223 ignore 224 type 224 category 224 substitution 225 Chapter 11 Information Stream Log Format DTD 226 Information Stream Log Format DTD 226 Chapter 12 Deployment Query DTD 228 Deployment Query DTD 228 Descriptions of Elements and Attributes 229 queryitem 229 query 229 and 229 or 230 predicate 230 key 231 textType 231 numericType 231 dateType 231 Chapter 13 Schedule DTD Schedule DTD 233 233 11 Descriptions of Elements and Attributes schedule 234 startTime 235 description 236 frequency 236 once 236 discrete 236 type 237 sub-hourly 237 hourly 237 daily 238 weekly 238 monthly 238 endTime 239 Chapter 14 OpenDeploy Manifest DTD 240 OpenDeploy Manifest DTD 240 Descriptions of Elements and Attributes 241 iwodManifest 241 profile 242 item 242 Chapter 15 Delivery Adapter DTDs Generic Delivery Adapter Configuration DTD 245 245 genericAdapter 245 deploy 246 rollback 246 Network Appliance NetCache Adapter Configuration DTD 246 netCacheServerConfiguration 247 serverSet 247 server 248 cacheProperties 249 BEA WebLogic Adapter Configuration DTD 12 234 249 weblogic 250 admin 251 action IBM WebSphere Adapter Configuration DTD 251 252 websphere 254 appsvr 254 wsadmin 254 application 255 action 256 taskoptions 257 portal 257 xmlaccess 257 Microsoft Application Center Adapter Configuration DTD 259 MSAppCenter 259 ACDeploy 260 DeploymentName 260 Source 261 Targets 261 Applications 261 ApplicationName 262 ApplicationGUID 262 NoACL 262 COMPLUS 262 NodeName 262 Credential 263 Microsoft COM+ Adapter Configuration DTD 263 MSCOM 264 COMPLUSApplication 265 Properties 265 DLLs 265 DLL 266 Components 266 Component 267 Property 267 Microsoft Global Assembly Cache (GAC) Adapter Configuration DTD 268 13 MSGAC 269 GlobalAssembly 269 ReferenceInfo 270 AssemblyNameToUninstall 270 BEA Bulk Loader Adapter Configuration DTD BEABulkLoader 271 load 272 Chapter 16 Payload Adapter DTDs Microsoft Visual SourceSafe (VSS) Adapter Configuration DTD 274 274 vss 275 vssGet 276 vssCheckout 277 vssItem 279 ClearCase Adapter Configuration DTD 279 clearcase 280 clearcaseUpdate 281 clearcaseCheckout 282 clearcaseItem 283 Serena (Merant) PVCS Adapter Configuration DTD 283 pvcs 284 pvcsGet 285 pvcsItem 287 Subversion Adapter Configuration DTD 287 suberversion 288 subversionCheckout 288 subversionItem 289 Chapter 17 Reporting Server Database Schema Initiator Table Schemas 291 291 IWOD_DEPLOYMENTS Table 291 IWOD_LEGS Table 292 IWOD_MANIFESTS Table 293 IWOD_DBMANIFESTS Table 294 Receiver Table Schemas 14 271 294 IWOD_RCVR_DEPLOYMENTS Table 294 IWOD_RCVR_MANIFESTS Table 295 IWOD_RCVR_DBMANIFESTS Table 296 DAS Table Schemas IWDD_DASEVENTS Table Chapter 18 Messages 297 297 298 LIB 298 ENG 303 SVR 306 CFG 307 DBD 308 Unnumbered Error Messages 308 15 16 Chapter 1 Command-Line Tools Chapter 1 Command-Line Tools OpenDeploy command line tools provide functionality by entering the command-line tool and its associated options at the command prompt. In some cases command-line tools provide an alternative to performing tasks in the OpenDeploy user interface. In other cases, a command-line tool is the only method to invoke a particular function or feature. Command-line tools only can be issued on the host where the OpenDeploy server is installed. Commands can be issued by anyone regardless of whether they hold an Administrator or User role. There are no authentication or authorization checks on individuals invoking command-line tools. iwodauthorize The iwodauthorize command-line tool is an authorization tool for deployments and deployment groups being invoked through the following methods: l browser-based user interface iwodcmd start l Web services l The iwodauthorize tool authorizes a group of users listed in a text file to run a set of deployment groups and individual deployment configurations, also listed in a separate text file. This functionality is limited to the OpenDeploy base server on which the command is being run. The iwodauthorize tool is not applicable to deployments invoked through commands that do not use iwodcmd, such as iwodstart. It is also not applicable to scheduled deployments. Usage iwodauthorize -h | -v iwodauthorize -r list od-role [-odinst instName] iwodauthorize -r (add | remove) od-role username ... [-odinst instName] iwodauthorize -d list od-user [-odinst instName] iwodauthorize -d (add | remove) od-user odinst instName] OpenDeploy Reference Guide deployment-name...[- 17 Chapter 1 Command-Line Tools iwodauthorize -d (add | remove | set) -ul user-filelist -dl deployment-filelist [-odinst instName] od-user -h Displays usage information. -v Displays version information. -ul user-filelist Specifies the path to the user file list for batch authorization. Each user entry must be on a separate line, for example: jdoe rroe jsmith If domain names are required, include them using the following syntax (note use of two backslashes): domain\\user For example: INTERWOVEN\\jdoe -dl deployment-filelist Specifies the path to the deployment file list for batch authorization. Each deployment group or individual configuration name must be on a separate line, for example: deployment1 deployment2 depgroup1/ -r list -r add Lists users in a specified OpenDeploy role. -r remove Removes users from a specified OpenDeploy role. od-role Specifies one of the following OpenDeploy roles: Adds users to a specified OpenDeploy role. l od-admin l od-user username Specifies the name of the user. od-user Specifies the name of a user with the od-user role. -d list Lists deployment authorizations for the od-user role. -d add Adds deployment authorizations to the od-user role. These are added to any existing authorizations already present. -d remove Removes deployment authorizations from the od-user role. Only those deployment groups and configurations in the list are removed. 18 OpenDeploy Reference Guide Chapter 1 Command-Line Tools Any previous authorizations are retained. -d set Resets the deployment authorizations for the od-user role with only those deployment groups and configurations in the deployment list. Any previous authorizations are lost. You can remove all deployment authorizations by specifying an empty file for the deploymentfilelist value. -odinst instName Uses OpenDeploy server instance instName. Examples Authorize users listed in file /work/users.txt to run deployments listed in file /work/deployments.txt: iwodauthorize -d add -ul /work/users.txt -dl /work/deployments.txt Unauthorize users listed in file /work/users.txt from running deployments in file/work/deployments.txt: iwodauthorize -d remove -ul /work/users.txt -dl /work/deploments.txt Display a list of users in the od-admin role: iwodauthorize -r list od-admin Display a list of users in the od-user role: iwodauthorize -r list od-user Add the UNIX users mary and david to the od-admin role: iwodauthorize -r add od-admin mary david Remove the Windows users INTERWOVEN\jill and INTERWOVEN\sally from the od-user role: iwodauthorize -r remove od-user INTERWOVEN\\jill INTERWOVEN\\sally Note: Two backslashes (“\\”) are required to separate the domain from the user name here and in the subsequent examples. Display a list of authorized deployments for the od-user INTERWOVEN\bill: iwodauthorize -d list INTERWOVEN\\bill Add the deployments deploy1 and deploy2 to the od-user INTERWOVEN\bill: iwodauthorize -d add INTERWOVEN\\bill deploy1 deploy2 Remove the deployment Eastcoast/NewYork and deployment group Westcoast from the od-role robert: iwodauthorize -d remove robert Eastcoast/NewYork Westcoast/ OpenDeploy Reference Guide 19 Chapter 1 Command-Line Tools The iwodauthorize command returns the following codes regarding the status of the deployment: l 0 succeeded l 1 failed to start iwodcmd The iwodcmd command-line tool executes an OpenDeploy action. This command-line tool provides a lighter-weight alternative to the following Java-based command-line tools: l iwodstart l iwodschedadd l iwodschedget l iwodscheddelete l iwodschedactivate l iwodserverstatus l iwodserverreset l iwoddeploycancel For example, the following use of iwodcmd: iwodcmd start mydeployment is equivalent to: iwodstart mydeployment All the actions are applicable to a base server. Only the serverstatus and serverreset actions are applicable to a receiver. In addition, there are several other commands that also use the iwodcmd that do not have a legacy command-line tool equivalent. Usage iwodcmd -h | -v iwodcmd [-odinst instName] [-host hostname ] [-port portname] action arguments -h Displays usage information. -v Displays version information. -odinst instName Uses OpenDeploy server instance instName. -host hostname Specifies the hostname/network address to execute the OpenDeploy action. If this option is not specified, OpenDeploy uses the Deploy.cltProxyHost value specified in the service configuration file (deploy.cfg). -port portname Specifies the port number to which a connection can be 20 OpenDeploy Reference Guide Chapter 1 Command-Line Tools made. If this option is not specified, OpenDeploy uses the Deploy.cltProxyPort value specified in the service configuration file (deploy.cfg). action Specifies any of the following of actions: l start l schedadd l schedget l scheddelete l schedactivate l serverstatus l serverreset l deploycancel These actions can be preceded with the iwod prefix, for example iwod start. arguments Specifies arguments related to each supported action. The following sections describe each of the iwodcmd actions. start Starts an OpenDeploy deployment task. By default, authorization checking occurs when invoking a deployment using iwodcmd start. Refer to “Roles and Authorization” in the OpenDeploy Administration Guide for more information. You can disable the default authorization checking by modifying the service configuration file (deploy.cfg). Refer to “Disabling Authorization Checking for Deployments Invoked Using iwodcmd start” in the OpenDeploy Administration Guide for more information. Usage start -h | -v start deployment [-async] [-inst instance] [-k "key=value"]+ [-sim] [-V (normal | verbose)] -h Displays usage information. -v Displays version information. deployment -async Name of the deployment to start. -inst instance Includes the deployment instance name instance, which is a suffix that is appended to the deployment name. This option is used to create unique deployment names for each instance of a deployment configuration. -k "key=value" Specifies the key/value substitution. Note that the parameter iwdd is reserved when you are performing a Runs iwodstart command asynchronously. The iwodstart command returns before the deployment completes. OpenDeploy Reference Guide 21 Chapter 1 Command-Line Tools deployment of a DataDeploy configuration. You may not use other parameter variables of the name iwdd. -sim Enables the simulated deployment feature. -V arg Logging level with verbose or normal as args. The iwodcmd start command returns the following codes regarding the status of the deployment: l 0 succeeded l 1 failed to start l 2 ran and returned a failed status l 9 completed with errors schedadd Adds a schedule for a deployment configuration. Usage schedadd -h | -v schedadd deployment [-r [n][m|h|d|w]] [-s [n][m|h|d|w]] [-e [n] [m|h|d|w]]] [-c comment] [-inst instance] [-k "key=value"]+ -h Displays usage information. -v Displays version information. deployment -r Name of the deployment being scheduled. -s [N][m|h|d|w] Time from current time to use as start date. The default is 1 minute from entered command time. -e [N][m|h|d|w] Amount of time from current time to use as end date. The default end time is none. The scheduled deployment continues indefinitely. n m A numerical value. h Hours. d Days. w Weeks. -c comment Description of the deployment being scheduled. -inst instance Includes the deployment instance name instance, which is a suffix that is appended to the deployment name. This option is used to create unique deployment names for each instance of a deployment configuration. -k key=value Specifies the key/value substitution. Note that the parameter iwdd is reserved when you are performing a deployment of a DataDeploy configuration. You may not use other parameter variables of the name iwdd. Repeat every N minutes, hours, days, or weeks. Minutes. schedget 22 OpenDeploy Reference Guide Chapter 1 Command-Line Tools Retrieves scheduled deployments from the Open Deploy scheduler database and reports selected information back to the user. Usage schedget -h | -v schedget -a schedget -d deployment schedget -o deployment -j ID -h Displays usage information. -v Displays version information. -a Gets all schedules. This is the default option. -d deployment Gets all schedules for a particular deployment. -o deployment Gets one schedule. Requires the deployment name and the deployment ID number. deployment The name of the deployment configuration. -j ID Specifies a job. The ID number of the deployment. Each time a deployment runs, that deployment is given a unique ID number. Similarly, when you schedule a deployment, that scheduled deployment is also given a issued a unique ID number. Use the -a option to see all the ID number for your deployment. scheddelete Deletes an existing scheduled deployment. Usage scheddelete -h | -v scheddelete deployment -j ID scheddelete "dep_name_pattern*" [-j ID] -h Displays usage information. -v Displays version information. deployment The name of the deployment configuration. -j ID Specifies a job. The ID number of the deployment. Each time a deployment runs, that deployment is given a unique ID number. Similarly, when you schedule a deployment, that scheduled deployment is also given a issued a unique ID number. Use the iwodschedget -a command to see all the ID number for your deployment. "dep_name_pattern*" Deletes schedules based on a wild card name selection, with an optional job identifying number (j option). The wild card pattern must be quoted ("sample*"). If the optional job identifying number (-j option) is not present, all scheduled OpenDeploy Reference Guide 23 Chapter 1 Command-Line Tools dep...
View Full Document

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture