Post on 26-Mar-2020
transcript
Deployment AutomationPlugins Guide
Copyright © 2013-2017 Serena Software, Inc. All rights reserved.
This document, as well as the software described in it, is furnished under license and may be used or copied onlyin accordance with the terms of such license. Except as permitted by such license, no part of this publicationmay be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means,electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproductionof such software product user documentation, regardless of whether the documentation is reproduced in wholeor in part, must be accompanied by this copyright statement in its entirety, without modification. This documentcontains proprietary and confidential information, and no reproduction or dissemination of any informationcontained herein is allowed without the express permission of Serena Software.
The content of this document is furnished for informational use only, is subject to change without notice, andshould not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errorsor inaccuracies that may appear in this document.
License and copyright information for 3rd party software included in this release can be found on the product'snews page at http://support.serena.com/ProductNews/default.aspx and may also be found as part of thesoftware download available at http://support.serena.com.
Trademarks
Serena, Dimensions, ChangeMan, Comparex, and StarTool are registered trademarks of Serena Software, Inc.The Serena logo, PVCS, TeamTrack, License Manager and Composer are trademarks of Serena Software, Inc. Allother products or company names are used for identification purposes only, and may be trademarks of theirrespective owners.
U.S. Government Rights
Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, itsagencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosureby the U.S. Government is subject to the restrictions set forth in the license under which the Software wasacquired. The manufacturer is Serena Software, Inc., 2345 NW Amberbrook Drive, Suite 200, Hillsboro, OR97006.
Part number: 6.1.4
Publication date: 2017-05-17
2 Deployment Automation
Table of ContentsPart 1: Introduction .......................................................................................... 19
Chapter 1: Deployment Automation Plugins ...................................................... 21
What are Plugins? ....................................................................................... 21
Plugins at Run-time ....................................................................................... 22
List of Available Plugins ................................................................................. 23
Part 2: Application Server Management Plugins ................................................... 29
Chapter 2: Apache HTTP Server Plugin ............................................................... 31
Creating an Apache Start Step ........................................................................ 31
Creating an Apache Stop Step ........................................................................ 31
Chapter 3: Apache Tomcat Plugin ..................................................................... 33
Creating a Tomcat Deploy Application Step ...................................................... 33
Creating a Tomcat Undeploy Application Step ................................................... 34
Creating a Tomcat Start Application Step ......................................................... 34
Creating a Tomcat Stop Application Step ......................................................... 34
Creating a Tomcat Start Step ........................................................................ 35
Creating a Tomcat Stop Step ........................................................................ 36
Creating a Check if Tomcat is Alive Step ......................................................... 37
Chapter 4: GlassFish Plugin .............................................................................. 39
Chapter 5: IBM WebSphere Application Server Plugin .......................................... 41
Creating a WebSphere Check Application is Not Running Step ........................... 42
Creating a WebSphere Check Application is Running on Server or Cluster Step ...... 44
Creating a WebSphere Check if Config Object Exists Step ................................. 45
Creating a WebSphere Check Initial Heap Size Step .......................................... 46
Creating a WebSphere Check Maximum Heap Size Step .................................... 47
Creating a WebSphere Check Status Step......................................................... 49
Creating a WebSphere Create Cluster step ...................................................... 50
Creating a WebSphere Create Cluster Member Step .......................................... 51
Creating a WebSphere Create DataSource Step ................................................ 52
Plugins Guide 3
Creating a WebSphere Create DataSource for Cluster Step ................................. 53
Creating a WebSphere Create JDBCProvider for Cluster Step .............................. 55
Creating a WebSphere Create JDBCProvider Step ............................................. 57
Creating a WebSphere Create a SIBJMSConnectionFactory Step ........................ 58
Creating a WebSphere Create SIBJMSQueue Step ............................................. 59
Creating a WebSphere Create SIBJMSTopic Step ............................................. 61
Creating a WebSphere Execute wsadmin Script Step.......................................... 62
Creating a WebSphere Export DataSource Properties from a Cluster Step ............ 63
Creating a WebSphere Export JVMHeapSizes from Server Step ........................... 64
Creating a WebSphere Export Application Step ................................................ 65
Creating a WebSphere Generate Plugin Step ................................................... 67
Creating a WebSphere Import DataSource Properties into Cluster Step ............... 68
Creating a WebSphere Import JVMHeapSizes for Cluster Step ........................... 70
Creating a WebSphere Install Application Step ................................................ 71
Creating a WebSphere Install or Update Application Step.................................... 72
Creating a WebSphere Modify Application ClassLoaders Step .............................. 74
Creating a WebSphere Restart Application Step ................................................ 75
Creating a WebSphere Restart Server Step ...................................................... 77
Creating a WebSphere Start Application Step ................................................... 78
Creating a WebSphere Start Server Step ......................................................... 79
Creating a WebSphere Stop Application Step ................................................... 81
Creating a WebSphere Stop Server Step ......................................................... 82
Creating a WebSphere Synchronize Nodes Step ................................................ 83
Creating a WebSphere Uninstall Application Step ............................................. 84
Creating a WebSphere Update J2EEResourceProperty on a Config Object Step ...... 85
Creating a WebSphere Update Simple Attribute on Object Step ........................... 87
Creating a WebSphere Update Application Step ................................................ 88
Creating a WebSphere Wait for Application Step................................................ 90
Creating a Websphere Wait for Server or Cluster Step ....................................... 91
4 Deployment Automation
Chapter 6: IBM WebSphere MB Plugin ............................................................... 93
Creating a WebSphere WMB Set Broker Properties Step .................................... 93
Creating a WebSphere WMB Set Execution Group Properties Step........................ 94
Creating a WebSphere WMB Set Message Flows Property Step ........................... 95
Creating a WebSphere WMB Delete Flows Using RegEx Step .............................. 96
Creating a WebSphere WMB Deploy Step ......................................................... 97
Creating a WebSphere WMB Start Message Flows Step....................................... 98
Creating a WebSphere WMB Stop Message Flows Step ....................................... 99
Chapter 7: IBM WebSphere MQ ..................................................................... 101
Creating a WebSphere Create Queue Manager Step ....................................... 101
Creating a WebSphere Manage Queue Depth Step .......................................... 102
Creating a WebSphere Start Queue Manager Step .......................................... 102
Creating a WebSphere Stop Queue Manager Step .......................................... 103
Creating a WebSphere Define Queue Step ................................................... 103
Creating a WebSphere Run MQ Script Step ................................................... 104
Chapter 8: JBoss Plugin .............................................................................. 107
Creating an Add Data Source Step ............................................................... 108
Creating an Add JMS Connection Factory Step................................................ 109
Creating an Add JMS Queue Step ............................................................... 110
Creating an Add JMS Topic Step .................................................................. 110
Creating a Check Deployment Status Step ................................................... 111
Creating a Create Server Group Step ............................................................ 111
Creating a Deploy Application Step ............................................................... 112
Creating a Deploy JDBC Driver Step ............................................................ 113
Creating a Disable Application Step ............................................................ 113
Creating an Enable Application Step ............................................................ 114
Creating an Enable Data Source Step............................................................ 115
Creating a Remove JMS Connection Factory Step .......................................... 115
Creating a Remove JMS Queue Step ............................................................ 116
Creating a Remove JMS Topic Step............................................................... 116
Plugins Guide 5
Creating a Run Script Step ........................................................................ 117
Creating a Start JBoss Step ........................................................................ 117
Creating a Start Server Step........................................................................ 118
Creating a Start Server Group Step ............................................................ 119
Creating a Stop JBoss Step ........................................................................ 119
Creating a Stop Server Step ........................................................................ 119
Creating a Stop Server Group Step............................................................... 120
Creating an Undeploy Application Step ......................................................... 120
Chapter 9: IIS AdminScripts Plugin ............................................................... 123
Creating an AdsUtil Step ........................................................................... 123
Creating an Update WebSiteProperties Step................................................... 124
Creating an Update VDirProperties Step ...................................................... 124
Creating a Set .Net Version Step .................................................................. 124
Chapter 10: IIS AppCmd Plugin ..................................................................... 127
Creating a Create Application Step ............................................................... 127
Creating a Delete Application Step ............................................................... 128
Creating a Create Site Step ........................................................................ 128
Creating a Delete Site Step ........................................................................ 129
Creating a Start Site Step ........................................................................... 129
Creating a Stop Site Step ........................................................................... 130
Creating a Check if Site Exists Step ............................................................ 130
Creating a Check if Site is Stopped Step ...................................................... 131
Creating a Check if Site is Running Step ...................................................... 131
Creating a Create Virtual Directory Step ...................................................... 132
Creating a Delete Virtual Directory Step ...................................................... 132
Creating a Create Application Pool Step......................................................... 133
Creating a Delete Application Pool Step ......................................................... 133
Creating a Start Application Pool Step ......................................................... 134
Creating a Stop Application Pool Step ......................................................... 134
Creating a Recycle Application Pool Step ...................................................... 135
6 Deployment Automation
Creating an AppCmd Step ........................................................................... 135
Chapter 11: Microsoft IIS MS-Deploy Plugin ................................................... 137
Creating a Synchronize Step........................................................................ 137
Creating an MSDeploy Step ........................................................................ 139
Creating a Delete Step .............................................................................. 140
Creating a Stop Application Step .................................................................. 141
Creating a Recycle Application Step ............................................................ 142
Chapter 12: Oracle WebLogic WLDeploy Plugin ................................................ 143
Creating a Run WLDeploy Step..................................................................... 143
Creating a Start Targets Step ..................................................................... 145
Creating a Stop Targets Step ..................................................................... 146
Creating a Check Targets Step ..................................................................... 147
Creating a Check Application on Targets Step ................................................ 148
Creating a Wait for Application on Targets Step ............................................. 149
Creating a List Applications on Targets Step................................................... 150
Creating a Create Data Source Step ............................................................ 151
Creating a Configure Data Source Step ......................................................... 151
Creating a Deploy Service Bus Configuration Step .......................................... 152
Part 3: Build Management Plugins .................................................................. 155
Chapter 13: Apache Ant Plugin ..................................................................... 157
Creating an Execute an Ant Script Step ......................................................... 157
Chapter 14: Apache Maven Plugin .................................................................. 159
Chapter 15: Jenkins Plugin ........................................................................... 161
Creating a Jenkins Get Build Changes Step ................................................... 161
Creating a Jenkins Get Build Status Step ...................................................... 162
Creating a Jenkins Submit Job Step ............................................................ 162
Chapter 16: MS Build Plugin ........................................................................ 165
Chapter 17: UrbanCode AnthillPro Plugin ......................................................... 167
Part 4: Change and Service Management Plugins................................................ 169
Chapter 18: Atlassian JIRA Plugin .................................................................. 171
Creating an Add Comments Step.................................................................. 171
Plugins Guide 7
Creating a Check Status Step ..................................................................... 172
Creating a Create Issue Step ..................................................................... 173
Creating a Publish Issue Report Step ............................................................ 173
Creating an Update Issue Step..................................................................... 174
Chapter 19: CollabNet TeamForge Plugin......................................................... 177
Chapter 20: JFrog Artifactory Plugin ............................................................... 179
Creating a Download Artifacts Step............................................................... 179
Chapter 21: Microsoft Sharepoint Plugin ......................................................... 181
Chapter 22: SBM Plugin .............................................................................. 183
Creating a Send ALF Event Step .................................................................. 183
Creating a Send DA ALF Event Step ............................................................ 184
Chapter 23: ChangeMan ZMF Plugin ............................................................... 187
Creating a ChangeMan ZMF Approve Step ................................................... 188
Creating a ChangeMan ZMF Audit Step ......................................................... 189
Creating a ChangeMan ZMF Backout Step...................................................... 192
Creating a ChangeMan ZMF Confirm for Backout Step .................................... 193
Creating a ChangeMan ZMF Confirm for Freeze Step ....................................... 194
Creating a ChangeMan ZMF Confirm for Promotion Step ................................. 196
Creating a ChangeMan ZMF Confirm for Revert Step ....................................... 197
Creating a ChangeMan ZMF Delete Package Step .......................................... 199
Creating a ChangeMan ZMF Delete Scheduled Deployment Step ..................... 200
Creating a ChangeMan ZMF Demote a Package Step ....................................... 201
Creating a ChangeMan ZMF Demote and Delete Contents Step ........................ 203
Creating a ChangeMan ZMF Freeze a Package Step ....................................... 204
Creating a ChangeMan ZMF Get App Params Step .......................................... 205
Creating a ChangeMan ZMF Get App Promotion Areas Step .............................. 206
Creating a ChangeMan ZMF Get App Sites Step ............................................. 208
Creating a ChangeMan ZMF Get Approvers Step ............................................. 209
Creating a ChangeMan ZMF Get Install Sites Step .......................................... 210
Creating a ChangeMan ZMF Get Instructions Step .......................................... 212
8 Deployment Automation
Creating a ChangeMan ZMF Get Properties Step ............................................. 213
Creating a ChangeMan ZMF Get Scheduled Deployment Step ........................... 214
Creating a ChangeMan ZMF Get User Variables Step ....................................... 216
Creating a ChangeMan ZMF Hold Deployment Step ....................................... 217
Creating a ChangeMan ZMF Promote Package Step ....................................... 218
Creating a ChangeMan ZMF Query Package Step .......................................... 220
Creating a ChangeMan ZMF Reject Package Step .......................................... 226
Creating a ChangeMan ZMF Release Deployment Step .................................... 227
Creating a ChangeMan ZMF Revert Package Step .......................................... 228
Creating a ChangeMan ZMF Undelete Package Step ....................................... 230
Creating a ChangeMan ZMF Update Scheduled Deployment Step ..................... 231
Chapter 24: Dimensions CM Plugin ............................................................... 233
Creating a Dimensions CM Action Baseline Step ............................................. 233
Creating a Dimensions CM Create Baseline Step ............................................. 234
Creating a Dimensions CM Deliver to a Stream Step ....................................... 235
Creating a Dimensions CM Demote Baseline Step .......................................... 236
Creating a Dimensions CM Deploy Baseline Step............................................. 237
Creating a Dimensions CM Get Baselines Step................................................ 239
Creating a Dimensions CM Get Deployment Areas Step ................................. 239
Creating a Dimensions CM Get Products Step ................................................ 240
Creating a Dimensions CM Get Projects and Streams Step .............................. 241
Creating a Dimensions CM Get Stages Step ................................................... 242
Creating a Dimensions CM Promote Baseline Step .......................................... 242
Creating a Dimensions CM Rollback Area Version Step .................................... 244
Creating a Dimensions CM Upload Local File or Directory Step ........................ 244
Chapter 25: PVCS VM Plugin ........................................................................ 247
Creating a PVCS Export Step ..................................................................... 247
Chapter 26: ServiceNow Plugin ..................................................................... 249
Creating a Check Approval State Step ......................................................... 249
Creating a Check Change Request Child Task States Step .............................. 250
Plugins Guide 9
Creating a Check Change Request State Step ................................................ 251
Creating a Delete Multiple Rows from CMDB Table Step ................................. 252
Creating a Delete Row from CMDB Table Step ................................................ 253
Creating an Insert Row into CMDB Table Step ................................................ 254
Creating a Set Change Request State Step ................................................... 255
Creating an Update Task States Step ............................................................ 255
Chapter 27: Subversion Plugin ..................................................................... 257
Creating a Subversion Add Step .................................................................. 258
Creating a Subversion Checkout Step ......................................................... 258
Creating a Subversion Clean Up Step ............................................................ 259
Creating a Subversion Commit Step ............................................................ 259
Creating a Subversion Create Branch or Tag Step .......................................... 260
Creating a Subversion Create Repository Step................................................ 261
Creating a Subversion Delete Step ............................................................... 261
Creating a Subversion Export Step (5.0.1 Plugin Version) .............................. 262
Creating a Subversion Get Lock Step ............................................................ 262
Creating a Subversion Import Step............................................................... 263
Creating a Subversion Move Step ............................................................... 264
Creating a Subversion Release Lock Step ...................................................... 264
Creating a Subversion Revert Step ............................................................... 265
Creating a Subversion Switch Step ............................................................... 266
Creating a Subversion Update Step ............................................................ 267
Creating a Subversion Export Step (4.5.1 Plugin Version) .............................. 267
Part 5: Database Management Plugins ............................................................ 269
Chapter 28: DBDeploy Plugin ........................................................................ 271
Creating a Run DbDeploy Step ..................................................................... 271
Chapter 29: DBUpgrader Plugin ..................................................................... 273
Chapter 30: SQLCMD Plugin ........................................................................ 275
Creating a Run SQLCMD Scripts Step ............................................................ 275
Chapter 31: SQL*Plus Plugin ........................................................................ 277
10 Deployment Automation
Creating a Run SQLPlus Script Step ............................................................ 277
Chapter 32: SQL-JDBC Plugin ........................................................................ 279
Creating an Execute SQL Scripts Step ......................................................... 279
Part 6: Deployment and Release Automation Plugins .......................................... 281
Chapter 33: BMC ARA Plugin ........................................................................ 283
Chapter 34: Nolio Plugin .............................................................................. 285
Creating a Nolio Get Agents Step ............................................................... 285
Creating a Nolio Get Applications Step ......................................................... 286
Creating a Nolio Get Environments Step ...................................................... 286
Creating a Nolio Get Process Tags Step ......................................................... 287
Creating a Nolio Get Processes Step ............................................................ 288
Creating a Nolio Get Server Types Step......................................................... 289
Creating a Nolio Run Process Step ............................................................... 290
Creating a Nolio Schedule Process Run Step ................................................ 290
Chapter 35: DA Agent Properties Collector Plugin ............................................. 293
Chapter 36: DA Application Plugin .................................................................. 295
Creating a Create Application Step ............................................................... 295
Creating a Create Application Process Step ................................................... 296
Creating an Add Component To Application Step .......................................... 296
Creating a Create Application Property Step................................................... 296
Creating a Create Application Role Step ...................................................... 297
Creating a Run Application Process Step ...................................................... 297
Creating a Check if Application Exists Step ................................................... 298
Creating an Add User to Role Step ............................................................... 298
Creating an Add Group to Role Step ............................................................ 298
Chapter 37: DA Component Plugin.................................................................. 301
Creating a Create Component Step............................................................... 301
Creating a Create Component Property Step ................................................ 303
Creating a Create Component Role Step ...................................................... 303
Creating an Add User To Role For Component Step ....................................... 303
Plugins Guide 11
Creating an Add Group To Role For Component Step....................................... 304
Creating a Check If Component Exists Step ................................................... 304
Chapter 38: DA Configuration Management Plugin .......................................... 305
Creating an Install Template Step ............................................................... 305
Chapter 39: DA Environment Plugin ............................................................... 307
Creating a Create Environment Step ............................................................ 307
Creating a Create Component Mapping Step ................................................ 308
Creating a Create Environment Property Step ................................................ 308
Creating a Get Environment Properties Step ................................................ 309
Creating a Get Component Environment Properties Step ................................. 310
Creating an Inactivate Environment Step ...................................................... 310
Creating a Set Component Environment Property Step .................................... 311
Creating an Add User to Role For Environment Step ....................................... 311
Creating an Add Group to Role For Environment Step .................................... 312
Creating a Verify Inventory Status Step ...................................................... 312
Creating a Check If Environment Exists Step ................................................ 312
Chapter 40: DA Resource Plugin..................................................................... 315
Chapter 41: Deployment Automation System Plugin ....................................... 317
Creating a Deployment Automation System Property Step .............................. 317
Chapter 42: DA Version Plugin ..................................................................... 319
Chapter 43: DA VFS Plugin ........................................................................... 321
Creating a Download Artifacts Step............................................................... 321
Creating an Upload Artifacts Step ............................................................... 322
Creating an Upload Step Attachment Step ................................................... 323
Creating a Verify Local Artifacts Step ............................................................ 324
Part 7: Integration Plugins .............................................................................. 325
Chapter 44: Atlassian Bamboo Plugin ............................................................ 327
Creating a Get All Projects Step .................................................................. 327
Creating a Get All Plans Step ..................................................................... 327
Creating a Get Queued Builds Step ............................................................... 328
12 Deployment Automation
Creating a Make Build Step ........................................................................ 328
Creating a Get Build Comments Step ............................................................ 329
Creating an Add Build Comments Step ......................................................... 330
Chapter 45: Chef Plugin .............................................................................. 333
Creating a Chef Bootstrap *nix or Windows Node Step .................................... 334
Creating a Client Bulk Delete Step ............................................................... 335
Creating a Cookbook Bulk Delete Step ......................................................... 336
Creating a Create Cookbook Step ............................................................... 336
Creating a Create or Edit Role Step............................................................... 337
Creating a Create Recipe Step ..................................................................... 337
Creating a Delete Client Step ..................................................................... 338
Creating a Delete Cookbook Step ............................................................... 338
Creating a Delete Node Step........................................................................ 339
Creating a Delete Recipe Step ..................................................................... 339
Creating a Delete Role Step ........................................................................ 339
Creating a Delete User Step ........................................................................ 339
Creating a Deploy Chef Step ........................................................................ 339
Creating a Generic Knife Command Step ...................................................... 340
Creating an Install Cookbook from Site Step ................................................ 340
Creating a Node Bulk Delete Step ............................................................... 341
Creating a Role Bulk Delete Step .................................................................. 341
Creating a Run-list Add Step........................................................................ 341
Creating a Run-list Remove Step.................................................................. 342
Creating an Upload Step ........................................................................... 342
Chapter 46: Docker Plugin ........................................................................... 345
Creating a Build From Dockerfile Step ......................................................... 345
Creating a Commit Image Step .................................................................. 346
Creating an Execute Command Step ............................................................ 346
Creating an Export to Tar Step..................................................................... 346
Creating an Inspect Step ........................................................................... 347
Plugins Guide 13
Creating an Import from Tar Step ............................................................... 347
Creating a Pull Image Step ........................................................................ 347
Creating a Push Image Step ........................................................................ 348
Creating a Remove Container Step ............................................................... 348
Creating a Restart Container Step ............................................................... 349
Creating a Run Command Step .................................................................. 349
Creating a Save Image Step ........................................................................ 349
Creating a Start Container Step .................................................................. 350
Creating a Stop Container Step .................................................................. 350
Creating a Tag Image Step ........................................................................ 351
Chapter 47: Informatica Plugin ..................................................................... 353
Chapter 48: Microsoft BizTalk Plugin ............................................................... 355
Chapter 49: Oracle Business Intelligence Plugin................................................ 357
Creating a Create Parent Folder Step ............................................................ 357
Creating a Delete Folder Step ..................................................................... 358
Creating an Unarchive Step ........................................................................ 358
Chapter 50: Puppet Plugin ........................................................................... 361
Creating a List Class Info Step ..................................................................... 362
Creating a List Group Info Step .................................................................. 362
Creating a List Node Info Step ..................................................................... 362
Creating a Modify Class Info Step ............................................................... 363
Creating a Modify Group Info Step ............................................................... 364
Creating a Modify Node Info Step ............................................................... 366
Chapter 51: Web Services Plugin .................................................................. 369
Creating an Invoke REST Service Step ......................................................... 369
Creating an Invoke DA Service Step ............................................................ 371
Creating an Invoke SOAP Service Step ......................................................... 373
Part 8: Network Management Plugins ............................................................... 375
Chapter 52: Citrix NetScaler Plugin ............................................................... 377
Creating a NetScaler Check Service Group Bindings Step................................. 377
14 Deployment Automation
Creating a NetScaler Check Service Group Status Step.................................... 378
Creating a NetScaler Check Service Status Step ............................................. 379
Creating a NetScaler Disable Servers Step ................................................... 380
Creating a NetScaler Disable Services Step ................................................... 380
Creating a NetScaler Disable Service Groups Step .......................................... 381
Creating a NetScaler Enable Servers Step...................................................... 382
Creating a NetScaler Enable Services Step ................................................... 382
Creating a NetScaler Enable Service Groups Step .......................................... 383
Creating a NetScaler Save Configuration Step ................................................ 384
Chapter 53: F5 BIG-IP Plugin ........................................................................ 385
Chapter 54: Nagios XI Plugin ........................................................................ 387
Part 9: Quality and Test Management Plugins ................................................... 389
Chapter 55: Deploy Tools Plugin..................................................................... 391
Chapter 56: HP Quality Center Plugin ............................................................ 393
Creating a Create Issue Step ..................................................................... 393
Creating an Update Issues Step .................................................................. 394
Creating an Add Comments Step.................................................................. 396
Creating a Publish Issue Report Step ............................................................ 397
Creating a Run Test Set Step ..................................................................... 398
Creating a Publish Test Set Report Step ...................................................... 398
Creating a Check Status Step ..................................................................... 399
Creating a Query Defects Step ..................................................................... 400
Chapter 57: QuickTest Pro Plugin .................................................................. 403
Chapter 58: Rally Plugin .............................................................................. 405
Chapter 59: Selenium Plugin ........................................................................ 407
Chapter 60: Silk Central Plugin ..................................................................... 409
Creating an Execute Single Plan Step............................................................ 409
Creating an Execute Multiple Plans Step ...................................................... 410
Part 10: System Tools and Scripting Plugins ...................................................... 411
Chapter 61: 7zip Plugin................................................................................. 413
Plugins Guide 15
Creating a 7zip Extract Archive Step ............................................................ 413
Chapter 62: CA AutoSys Plugin ..................................................................... 415
Chapter 63: Email Client Plugin ..................................................................... 417
Creating a Send Email Step ........................................................................ 417
Chapter 64: FileUtils Plugin ........................................................................... 419
Chapter 65: Groovy Plugin ........................................................................... 421
Chapter 66: Linux System Tools Plugin ......................................................... 423
Creating an Add User Step ........................................................................ 423
Creating an Add Group Step ........................................................................ 423
Creating a Change File Ownership Step ......................................................... 424
Creating a Reboot Step .............................................................................. 425
Creating a Set File Permissions Step ............................................................ 425
Creating an Update fstab Step ..................................................................... 426
Chapter 67: Log Parser Plugin........................................................................ 429
Creating a RegExp Search Step .................................................................. 430
Creating a Convert to HTML Step ............................................................... 431
Chapter 68: Microsoft Message Queuing (MSMQ) Plugin .................................... 435
Chapter 69: Microsoft Software Installer (MSI) Plugin ....................................... 437
Chapter 70: MS Windows PowerShell Plugin ................................................... 439
Creating a Run a PowerShell Script Step ...................................................... 439
Chapter 71: MS Windows Service Control Manager Plugin ................................. 441
Chapter 72: MS Windows System Tools Plugin ................................................ 443
Creating a Modify ACLs Step ........................................................................ 443
Creating a Log off Notification Step............................................................... 445
Creating a Reboot Step .............................................................................. 446
Creating a Check File Contents Step ............................................................ 446
Creating an Add or Overwrite Registry Step ................................................... 446
Creating an Export Registry Subkey to File Step ............................................. 447
Creating an Import Registry Files Step ......................................................... 448
Creating a Configure DCOM Settings Step...................................................... 448
16 Deployment Automation
Creating a Create Message Queues Step ...................................................... 449
Creating an Enable Windows Features Step ................................................... 450
Creating a Disable Windows Features Step ................................................... 450
Creating a Create Windows Event Log Step ................................................... 451
Chapter 73: Red Hat Package Manager (RPM) Plugin ....................................... 453
Creating an Install RPM Step ..................................................................... 453
Creating an Uninstall RPM Step .................................................................. 453
Creating an Update RPM Step ..................................................................... 454
Chapter 74: Shell Plugin .............................................................................. 455
Creating a Run a Shell Script Step ............................................................... 455
Creating a Run a Shell Script with X Arguments Step .................................... 456
Chapter 75: System Information Plugin ......................................................... 457
Part 11: Virtual and Cloud Environment Management Plugins .............................. 459
Chapter 76: Amazon EC2 Plugin ..................................................................... 461
Creating an Amazon EC2 Launch Instance Step ............................................. 461
Creating an Amazon EC2 Security Group Step................................................ 462
Creating Amazon EC2 Start, Stop, and Terminate Instance Steps ..................... 463
Creating an Amazon EC2 Wait for Instance Step............................................. 464
Creating an Amazon EC2 Associate IPs Step ................................................ 464
Creating an Amazon EC2 Register Instances with LoadBalance Step .................. 465
Creating an Amazon EC2 Deregister Instances with LoadBalance Step ............... 466
Creating an Amazon EC2 Get Public DNS Step................................................ 466
Chapter 77: AWS CloudFormation Plugin ......................................................... 467
Creating an AWS CloudFormation List Stack Step .......................................... 467
Creating an AWS CloudFormation Modify Stack Step ....................................... 468
Creating an AWS CloudFormation Update Stack Step .................................... 468
Chapter 78: Microsoft Windows Azure Plugin ................................................... 471
Chapter 79: VMware vSphere ESXi Plugin ...................................................... 473
Chapter 80: VMware vCenter Plugin ............................................................... 475
Chapter 81: VMware Workstation Plugin ......................................................... 477
Plugins Guide 17
Creating a Clone VM Step ........................................................................... 477
Creating a Delete Snapshot Step .................................................................. 479
Creating a Revert to Snapshot Step ............................................................ 479
Creating a Start VM Step ........................................................................... 479
Creating a Stop VM Step ........................................................................... 480
Creating a Suspend VM Step........................................................................ 480
Creating a Take Snapshot Step .................................................................. 480
18 Deployment Automation
Part 1: Introduction
This introductory section contains the following information:
• Chapter 1: Deployment Automation Plugins [page 21]
Plugins Guide 19
Part 1: Introduction
20 Deployment Automation
Chapter 1: Deployment AutomationPlugins
This guide lists and describes the plugins included with Deployment Automation. Whenyou are creating processes, use these plugins to configure and execute steps needed foryour deployment, such as requests to application servers, build management tools,database and file management systems, and test automation tools.
All of the plugins include self-documentation. As you use plugins within the processes,click the ? icon beside the properties fields to see a short description of each property.
See the Deployment Automation User's Guide for more information on designingprocesses.
Note: If you require documentation for a plugin beyond that provided in theDeployment Automation guides and online Help, please check theKnowledgebase and follow your usual Support procedures.
Important: The plugin steps specified in the Deployment Automation processesoften require pre-existing conditions, such as existing accounts, licenses,security, and login credentials. You should consult the integrating products'documentation for information on how to configure and use the integratingsoftware.
• What are Plugins? [page 21]
• Plugins at Run-time [page 22]
• List of Available Plugins [page 23]
What are Plugins?Deployment Automation plugins provide tools for creating component processes. Pluginsconsist of configurable steps which can be thought of as distinct pieces of automation.Plugins integrate many third-party tools into Deployment Automation, such as applicationservers and software configuration management products.
By combining steps in the Deployment Automation editor, you can create fully-automateddeployment processes. For example, the Tomcat and WebSphere plugins provide stepsthat start and stop those servers, install and uninstall applications, as well as performother tool-specific tasks.
Each plugin step consists of a number of properties, a command that performs thefunction associated with the step, and post-processing instructions, which typically areused to ensure that expected results occurred. Step properties can serve many purposes,from providing information required by the step's command, to supplying some or all ofthe actual command itself.
When you create a process, you drag steps onto the editor's design area and define theirproperties as you go. Property values can be supplied when defining a component processor at run-time. The process flow is defined by drawing connections between steps.
Plugins Guide 21
In the following figure, you can see a series of plugin steps and the connections betweenthem. For information about creating component processes and creating your own post-processing scripts, see the Deployment Automation User's Guide.
Plugins at Run-time
Component processes are run by agents installed in the target environment. For a processto run successfully, the agent must have access to all resources, tools, and files requiredby the plugin steps used in the process. When installing an agent, ensure that:
• The agent running the process has the necessary user permissions to executecommands and access any required resources. This typically entails grantingpermissions if an external tool is installed as a different user; installing the agent asa service; or impersonating the appropriate user.
• Any external tools required by plugin steps are installed in the target environment.
• The required minimum version of any external tool is installed.
Plugins at Run-timeComponent processes are run by agents installed in the target environment. For a processto run successfully, the agent must have access to all resources, tools, and files requiredby the plugin steps used in the process. When installing an agent, ensure that:
Part 1: Introduction
22 Deployment Automation
• The agent running the process has the necessary user permissions to executecommands and access any required resources. This typically entails grantingpermissions if an external tool is installed as a different user, installing the agent asa service, or impersonating the appropriate user.
• Any external tools required by plugin steps are installed in the target environment.
• The required minimum version of any external tool is installed.
List of Available PluginsThe plugins provided with Deployment Automation are listed here, divided into broadusage categories. Other than the standard plugins, which are pre-loaded, these pluginsmust be loaded into Deployment Automation through Administration > Automation >Plugins before they can be selected to execute in a process.
Note:
• The included Utility Steps are used to acquire process locks, execute amanual task, set status, run global processes, and do other generalprocess operations. See the Deployment Automation User's Guide fordetails.
• New plugins are actively in development. If you don't see a plugin that youneed in this list, please search the Support Knowledgebase and follow yourusual Support procedures.
• Get and share plugins on the Community website.
Plugins Guide 23
Part 2: Application ServerManagement Plugins [page 29]
Part 3: Build Management Plugins[page 155]
• Chapter 2: Apache HTTP ServerPlugin [page 31]
• Chapter 3: Apache Tomcat Plugin[page 33]
• Chapter 4: GlassFish Plugin [page39]
• Chapter 5: IBM WebSphereApplication Server Plugin [page 41]
• Chapter 6: IBM WebSphere MBPlugin [page 93]
• Chapter 7: IBM WebSphere MQ[page 101]
• Chapter 8: JBoss Plugin [page 107]
• Chapter 9: IIS AdminScripts Plugin[page 123]
• Chapter 10: IIS AppCmd Plugin[page 127]
• Chapter 11: Microsoft IIS MS-Deploy Plugin [page 137]
• Chapter 12: Oracle WebLogicWLDeploy Plugin [page 143]
• Chapter 13: Apache Ant Plugin [page157]
• Chapter 14: Apache Maven Plugin [page159]
• Chapter 15: Jenkins Plugin [page 161]
• Chapter 16: MS Build Plugin [page 165]
• Chapter 17: UrbanCode AnthillPro Plugin[page 167]
Part 1: Introduction
24 Deployment Automation
Part 4: Change and ServiceManagement Plugins [page 169]
Part 5: Database Management Plugins[page 269]
• Chapter 18: Atlassian JIRA Plugin[page 171]
• Chapter 19: CollabNet TeamForgePlugin [page 177]
• Chapter 20: JFrog Artifactory Plugin[page 179]
• Chapter 21: Microsoft SharepointPlugin [page 181]
• Chapter 22: SBM Plugin [page 183]
• Chapter 23: ChangeMan ZMF Plugin[page 187]
• Chapter 24: Dimensions CM Plugin[page 233]
• Chapter 25: PVCS VM Plugin [page247]
• Chapter 26: ServiceNow Plugin[page 249]
• Chapter 27: Subversion Plugin[page 257]
• Chapter 28: DBDeploy Plugin [page 271]
• Chapter 29: DBUpgrader Plugin [page273]
• Chapter 30: SQLCMD Plugin [page 275]
• Chapter 31: SQL*Plus Plugin [page 277]
• Chapter 32: SQL-JDBC Plugin [page279]
Plugins Guide 25
Part 6: Deployment and ReleaseAutomation Plugins [page 281]
Part 7: Integration Plugins [page 325]
• Chapter 33: BMC ARA Plugin [page283]
• Chapter 34: Nolio Plugin [page 285]
• Chapter 35: DA Agent PropertiesCollector Plugin [page 293] *
• Chapter 36: DA Application Plugin[page 295] *
• Chapter 37: DA Component Plugin[page 301] *
• Chapter 38: DA ConfigurationManagement Plugin [page 305] *
• Chapter 39: DA Environment Plugin[page 307] *
• Chapter 40: DA Resource Plugin[page 315] *
• Chapter 41: DeploymentAutomation System Plugin [page317] *
• Chapter 42: DA Version Plugin[page 319] *
• Chapter 43: DA VFS Plugin [page321] *
• Chapter 44: Atlassian Bamboo Plugin[page 327]
• Chapter 45: Chef Plugin [page 333]
• Chapter 46: Docker Plugin [page 345]
• Chapter 47: Informatica Plugin [page353]
• Chapter 48: Microsoft BizTalk Plugin[page 355]
• Chapter 49: Oracle Business IntelligencePlugin [page 357]
• Chapter 50: Puppet Plugin [page 361]
• Chapter 51: Web Services Plugin [page369]
Part 1: Introduction
26 Deployment Automation
Part 8: Network ManagementPlugins [page 375]
Part 9: Quality and Test ManagementPlugins [page 389]
• Chapter 52: Citrix NetScaler Plugin[page 377]
• Chapter 53: F5 BIG-IP Plugin [page385]
• Chapter 54: Nagios XI Plugin [page387]
• Chapter 55: Deploy Tools Plugin [page391]
• Chapter 56: HP Quality Center Plugin[page 393]
• Chapter 57: QuickTest Pro Plugin [page403]
• Chapter 58: Rally Plugin [page 405]
• Chapter 59: Selenium Plugin [page 407]
• Chapter 60: Silk Central Plugin [page409]
Plugins Guide 27
Part 10: System Tools and ScriptingPlugins [page 411]
Part 11: Virtual and Cloud EnvironmentManagement Plugins [page 459]
• Chapter 61: 7zip Plugin [page 413]
• Chapter 62: CA AutoSys Plugin[page 415]
• Chapter 63: Email Client Plugin[page 417]
• Chapter 64: FileUtils Plugin [page419] *
• Chapter 65: Groovy Plugin [page421]
• Chapter 67: Log Parser Plugin [page429]
• Chapter 68: Microsoft MessageQueuing (MSMQ) Plugin [page 435]
• Chapter 69: Microsoft SoftwareInstaller (MSI) Plugin [page 437]
• Chapter 70: MS WindowsPowerShell Plugin [page 439]
• Chapter 71: MS Windows ServiceControl Manager Plugin [page 441]
• Chapter 72: MS Windows SystemTools Plugin [page 443]
• Chapter 73: Red Hat PackageManager (RPM) Plugin [page 453]
• Chapter 74: Shell Plugin [page 455]*
• Chapter 75: System InformationPlugin [page 457] *
• Chapter 76: Amazon EC2 Plugin [page461]
• Chapter 77: AWS CloudFormation Plugin[page 467]
• Chapter 78: Microsoft Windows AzurePlugin [page 471]
• Chapter 79: VMware vSphere ESXiPlugin [page 473]
• Chapter 80: VMware vCenter Plugin[page 475]
• Chapter 81: VMware Workstation Plugin[page 477]
* Plugins marked with the asterisk are standard plugins, which are included in the serverinstallation. Other plugins must be loaded separately.
Part 1: Introduction
28 Deployment Automation
Part 2: Application Server ManagementPlugins
This section contains the following information:
• Chapter 2: Apache HTTP Server Plugin [page 31]
• Chapter 3: Apache Tomcat Plugin [page 33]
• Chapter 4: GlassFish Plugin [page 39]
• Chapter 5: IBM WebSphere Application Server Plugin [page 41]
• Chapter 6: IBM WebSphere MB Plugin [page 93]
• Chapter 7: IBM WebSphere MQ [page 101]
• Chapter 8: JBoss Plugin [page 107]
• Chapter 9: IIS AdminScripts Plugin [page 123]
• Chapter 10: IIS AppCmd Plugin [page 127]
• Chapter 11: Microsoft IIS MS-Deploy Plugin [page 137]
• Chapter 12: Oracle WebLogic WLDeploy Plugin [page 143]
Plugins Guide 29
Part 2: Application Server Management Plugins
30 Deployment Automation
Chapter 2: Apache HTTP Server Plugin
Apache HTTP Server is a public domain open source web server for UNIX and Windows NToperating systems.
In the Process Editor Available Plugin Steps, navigate to Application Server >Apache.
This plugin has the following steps for you to add to your processes:
• Creating an Apache Start Step [page 31]
• Creating an Apache Stop Step [page 31]
For information about Apache HTTP Server, see http://httpd.apache.org/.
Related TopicsChapter 3: Apache Tomcat Plugin [page 33]
Creating an Apache Start StepThis step starts Apache HTTP server.
Required properties: None
Optional properties:
PropertyName
Description
apachectlexecutablepath
The full path (including the executable) to the apachectl script, if noton the path. This is used only on *nix systems.
WindowsService name
The name of the Windows server used to control the Apache HTTPserver. This is only used on Windows systems.
Creating an Apache Stop StepThis step stops Apache HTTP server.
Plugins Guide 31
Required properties: None
Optional properties:
PropertyName
Description
apachectlexecutablepath
The full path (including the executable) to the apachectl script, if noton the path. This is used only on *nix systems.
WindowsService name
The name of the Windows server used to control the Apache HTTPserver. This is only used on Windows systems.
Part 2: Application Server Management Plugins
32 Deployment Automation
Chapter 3: Apache Tomcat Plugin
Apache Tomcat is an open source Web application server and servlet container. TheTomcat plugin may be used during deployments to execute Tomcat runbook automationand deploy or un-deploy Tomcat applications.
In the Process Editor Available Plugin Steps, navigate to Application Server > Java> Tomcat.
This plugin has the following steps for you to add to your processes:
• Creating a Tomcat Deploy Application Step [page 33]
• Creating a Tomcat Undeploy Application Step [page 34]
• Creating a Tomcat Start Application Step [page 34]
• Creating a Tomcat Stop Application Step [page 34]
• Creating a Tomcat Start Step [page 35]
• Creating a Tomcat Stop Step [page 36]
• Creating a Check if Tomcat is Alive Step [page 37]
For information about Apache Tomcat, see http://tomcat.apache.org/tomcat-7.0-doc/index.html.
Related TopicsChapter 2: Apache HTTP Server Plugin [page 31]
Creating a Tomcat Deploy Application StepThis step deploys a Web application to Tomcat.
Required properties:
Property Name Description
Tomcat Manager URL The URL of the Tomcat Manager interface.
Tomcat ManagerUsername
The username to use to login to the Tomcat Managerinterface.
Tomcat ManagerPassword
The password to use to login to the Tomcat Managerinterface.
Context Name The context that is being deployed.
War File Path The path to the war file being deployed.
Plugins Guide 33
Optional properties:
Property Name Description
Context XMLpath
The path of the context configuration file for this application, ifany.
Creating a Tomcat Undeploy Application StepThis step undeploys a Web application on Tomcat.
Required properties:
Property Name Description
Tomcat Manager URL The URL of the Tomcat Manager interface.
Tomcat ManagerUsername
The username to use to login to the Tomcat Managerinterface.
Tomcat ManagerPassword
The password to use to login to the Tomcat Managerinterface.
Context Name The context that is being deployed.
Optional properties: None
Creating a Tomcat Start Application StepThis step starts a Web application that is already deployed on Tomcat.
Required properties:
Property Name Description
Tomcat Manager URL The URL of the Tomcat Manager interface.
Tomcat ManagerUsername
The username to use to login to the Tomcat Managerinterface.
Tomcat ManagerPassword
The password to use to login to the Tomcat Managerinterface.
Context Name The context that is being deployed.
Optional properties: None
Creating a Tomcat Stop Application StepThis step stops a Web application that is already deployed on Tomcat.
Part 2: Application Server Management Plugins
34 Deployment Automation
Required properties:
Property Name Description
Tomcat Manager URL The URL of the Tomcat Manager interface.
Tomcat ManagerUsername
The username to use to login to the Tomcat Managerinterface.
Tomcat ManagerPassword
The password to use to login to the Tomcat Managerinterface.
Context Name The context that is being deployed.
Optional properties: None
Creating a Tomcat Start StepThis step starts Tomcat on the agent machine.
Required properties:
PropertyName
Description
Launcher The location of the Tomcat startup script. For example: /opt/tomcat/bin/startup.sh.
Optional properties:
PropertyName
Description
Options New line-separated list of additional options to pass to startup script.
Startuptimeout(inseconds)
Enter a value here if you want the step to wait for the Tomcat instance tocomplete the boot process before continuing. You need to provide a portvalue below which will be used to detect when the boot process iscomplete.
Port Enter a port which the step would use to detect when the Tomcat instanceis up and running. You can specify any of the connector ports yourinstance is configured with.
Hostname If your Tomcat instance is not listening on localhost then provide thehostname where it can be reached when it's running. Only used if waitingfor Tomcat to complete its boot sequence. Defaults to localhost if notspecified.
Plugins Guide 35
PropertyName
Description
CatalinaHome
Provide a value if you want to overwrite the CATALINA_HOMEenvironment variable or if one is not available.
JDKHome
Provide a value if you want to overwrite the JAVA_HOME environmentvariable or if one is not available.
JRE Home Provide a value if you want to overwrite the JRE_HOME environmentvariable or if one is not available.
Creating a Tomcat Stop StepThis step stops Tomcat on the agent machine.
Required properties:
PropertyName
Description
Launcher The location of the Tomcat startup script. For example: /opt/tomcat/bin/startup.sh.
Optional properties:
PropertyName
Description
Options New line-separated list of additional options to pass to startup script.
Shutdowntimeout(inseconds)
Enter a value here if you want the step to wait for the Tomcat instance tocomplete the shutdown sequence before continuing. You need to provide aport value below which will be used to detect when the shutdown processis complete.
Port Enter a port which the step would use to detect when the Tomcat instanceis up and running. You can specify any of the connector ports yourinstance is configured with.
Hostname If your Tomcat instance is not listening on localhost then provide thehostname where it can be reached when it's running. Only used if waitingfor Tomcat to complete its boot sequence. Defaults to localhost if notspecified.
CatalinaHome
Provide a value if you want to overwrite the CATALINA_HOMEenvironment variable or if one is not available.
Part 2: Application Server Management Plugins
36 Deployment Automation
PropertyName
Description
JDKHome
Provide a value if you want to overwrite the JAVA_HOME environmentvariable or if one is not available.
JRE Home Provide a value if you want to overwrite the JRE_HOME environmentvariable or if one is not available.
Creating a Check if Tomcat is Alive StepThis step checks to see if Tomcat is running on the agent machine.
Required properties: None
Optional properties:
PropertyName
Description
Checktimeout(inseconds)
Enter a value here if you want the step to wait for Tomcat to appear atselected host and port. Defaults to no timeout. Checks just once.
Port Enter a port which the step would use to detect when the Tomcat instanceis up and running. You can specify any of the connector ports yourinstance is configured with.
Hostname If your Tomcat instance is not listening on localhost then provide thehostname where it can be reached when it's running. Only used if waitingfor Tomcat to complete its boot sequence. Defaults to localhost if notspecified.
Plugins Guide 37
Part 2: Application Server Management Plugins
38 Deployment Automation
Chapter 4: GlassFish Plugin
GlassFish is an open source application server project started by Sun Microsystems for theJava EE platform; it is now sponsored by Oracle Corporation.
In the Process Editor Available Plugin Steps, navigate to Application Server > Java> GlassFish.
This plugin has the following steps for you to add to your processes:
• Deploy Application
• Undeploy Application
• Redeploy Application
• Enable Application
• Disable Application
• Start Domain
• Stop Domain
• Execute asadmin
For information about GlassFish, see https://glassfish.java.net/documentation.html.
Plugins Guide 39
Part 2: Application Server Management Plugins
40 Deployment Automation
Chapter 5: IBM WebSphere ApplicationServer Plugin
The IBM WebSphere Application Server, also known as WAS, is an Application Server builtusing J2EE, XML, and Web Services. WAS is supported on Windows, AIX, and Linux, aswell as other operating systems.
IBM WebSphere Application Server provides a Java application server runtimeenvironment and it can be used to connect website users to servlets. It allows users tocreate and manage sophisticated business websites.
In the Process Editor Available Plugin Steps, navigate to Application Server > Java> WebSphere.
This plugin has the following steps for you to add to your processes:
• Creating a WebSphere Check Application is Not Running Step [page 42]
• Creating a WebSphere Check Application is Running on Server or Cluster Step [page44]
• Creating a WebSphere Check if Config Object Exists Step [page 45]
• Creating a WebSphere Check Initial Heap Size Step [page 46]
• Creating a WebSphere Check Maximum Heap Size Step [page 47]
• Creating a WebSphere Check Status Step [page 49]
• Creating a WebSphere Create Cluster step [page 50]
• Creating a WebSphere Create Cluster Member Step [page 51]
• Creating a WebSphere Create DataSource Step [page 52]
• Creating a WebSphere Create DataSource for Cluster Step [page 53]
• Creating a WebSphere Create JDBCProvider for Cluster Step [page 55]
• Creating a WebSphere Create JDBCProvider Step [page 57]
• Creating a WebSphere Create a SIBJMSConnectionFactory Step [page 58]
• Creating a WebSphere Create SIBJMSQueue Step [page 59]
• Creating a WebSphere Create SIBJMSTopic Step [page 61]
• Creating a WebSphere Execute wsadmin Script Step [page 62]
• Creating a WebSphere Export DataSource Properties from a Cluster Step [page 63]
• Creating a WebSphere Export JVMHeapSizes from Server Step [page 64]
Plugins Guide 41
• Creating a WebSphere Export Application Step [page 65]
• Creating a WebSphere Generate Plugin Step [page 67]
• Creating a WebSphere Import DataSource Properties into Cluster Step [page 68]
• Creating a WebSphere Import JVMHeapSizes for Cluster Step [page 70]
• Creating a WebSphere Install Application Step [page 71]
• Creating a WebSphere Install or Update Application Step [page 72]
• Creating a WebSphere Modify Application ClassLoaders Step [page 74]
• Creating a WebSphere Restart Application Step [page 75]
• Creating a WebSphere Restart Server Step [page 77]
• Creating a WebSphere Start Application Step [page 78]
• Creating a WebSphere Start Server Step [page 79]
• Creating a WebSphere Stop Application Step [page 81]
• Creating a WebSphere Stop Server Step [page 82]
• Creating a WebSphere Synchronize Nodes Step [page 83]
• Creating a WebSphere Uninstall Application Step [page 84]
• Creating a WebSphere Update J2EEResourceProperty on a Config Object Step [page85]
• Creating a WebSphere Update Simple Attribute on Object Step [page 87]
• Creating a WebSphere Update Application Step [page 88]
• Creating a WebSphere Wait for Application Step [page 90]
• Creating a Websphere Wait for Server or Cluster Step [page 91]
For information about WAS, see http://www-01.ibm.com/software/websphere/.
Creating a WebSphere Check Application is NotRunning StepThis step is used to ensure an application is not running.
Required properties:
PropertyName
Description
Name Enter the name of your Check Application is Not Running step.
Part 2: Application Server Management Plugins
42 Deployment Automation
PropertyName
Description
ApplicationName
Set the name of the application that you want to check.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Plugins Guide 43
PropertyName
Description
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Check Application is Running onServer or Cluster StepUse this step to check to make sure an application is running on a server or cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Check Application is Not Running step.
ApplicationName
Set the name of the application that you want to check.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Part 2: Application Server Management Plugins
44 Deployment Automation
PropertyName
Description
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Check if Config Object ExistsStepUse this step to check if a config object exists in the WebSphere Configuration byContainment Path.
Required properties:
PropertyName
Description
Name Enter a name for the Check if Config Object Exists step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Plugins Guide 45
PropertyName
Description
ObjectContainmentPath
Enter the containment path to the object to check for. For example:/Cell:cellName/ServerCluster:clusterName/JDBCProvider:providerName/.
Note: The path must end with a JDBCProvider type and a "/".
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Check Initial Heap Size StepUse this step to check the initial heap size.
Required properties:
PropertyName
Description
Name Enter the name for your Check Initial Heap Size step.
Part 2: Application Server Management Plugins
46 Deployment Automation
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Server Name Enter the name of the server to check.
MinimumSize (MB)
Enter the minimum expected heap size in MBs.
MaximumSize (MB)
Enter the maximum expected heap size in MBs.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Check Maximum Heap Size StepUse this step to check the maximum heap size.
Plugins Guide 47
Required properties:
PropertyName
Description
Name Enter the name for your Check Maximum Heap Size step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Server Name Enter the name of the server to check.
MinimumSize (MB)
Enter the minimum expected heap size in MBs.
MaximumSize (MB)
Enter the maximum expected heap size in MBs.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Part 2: Application Server Management Plugins
48 Deployment Automation
Creating a WebSphere Check Status StepThis step is used to check the status of a WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Check Status step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Plugins Guide 49
PropertyName
Description
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Create Cluster stepThis step is used to create a new WebSphere cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Create Cluster step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
ClusterName
Enter the name of the new cluster that you want to create.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Part 2: Application Server Management Plugins
50 Deployment Automation
PropertyName
Description
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create Cluster Member StepThis step is used to create a new WebSphere cluster member.
Required properties:
PropertyName
Description
Name Enter the name for your Create Cluster Member step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
ClusterName
Enter the name of the new cluster member that you want to create.
Node Name Enter the name of the node for the new cluster member.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
Plugins Guide 51
PropertyName
Description
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create DataSource StepUse this step to create a DataSource on a given JDBCProvider.
Required properties:
PropertyName
Description
Name Enter the name for your Create DataSource step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
JDBCProviderLocation
Enter the containment path to the JDBCProvider. For example:/Cell:cellName/ServerCluster:clusterName/JDBCProvider:providerName/.
Note: The path must end with a JDBCProvider type and a"/".
DataSourceName
Enter the name of the datasource you want to create.
DataStoreHelperClassName
Enter the ClassName of the DataStore Helper.
Part 2: Application Server Management Plugins
52 Deployment Automation
PropertyName
Description
DB Name Enter the database name for the datasource.
JNDI Name Enter the JNDI name for the datasource.
Auth Alias Enter the auth alias to create or use for the datasource.
AliasUsername
Enter the username for the Auth Alias if it does not already exist.
AliasPassword
Enter the password for the Auth Alias if it does not already exist.
Description Enter a description for the datasource.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create DataSource for ClusterStepThis step is used to create a DataSource on a WebSphere cluster.
Plugins Guide 53
Required properties:
Property Name Description
Name Enter the name for your Create DataSource for Cluster step.
Connection Type Select the Connection Type to use with wsadmin. The defaultvalue is "SOAP". Possible values are:
• SOAP
• RMI
• NONE
Cluster Name Enter the name of the cluster that hosts the JDBCProvider.
JDBCProviderName
Enter the name of the JDBCProvider.
DataSource Name Enter the name of the datasource you want to create.
DataStore HelperClassName
Enter the ClassName of the DataStore Helper.
DB Name Enter the database name for the datasource.
JNDI Name Enter the JNDI name for the datasource.
Driver Type Enter the type of driver that is used by the datasource.
Server Name Enter the name of the server to which the datasource connects.
Port Number Enter the server's port number.
Auth Alias Enter the auth alias to create or use for the datasource.
Alias Username Enter the username for the Auth Alias if it does not already exist.
Alias Password Enter the password for the Auth Alias if it does not already exist.
Description Enter a description for the datasource.
Part 2: Application Server Management Plugins
54 Deployment Automation
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create JDBCProvider for ClusterStepUse this step to create a JDBCProvider on a cluster.
Required properties:
Property Name Description
Name Enter the name for your Create JDBCProvider for Cluster step.
Connection Type Select the Connection Type to use with wsadmin. The defaultvalue is "SOAP". Possible values are:
• SOAP
• RMI
• NONE
Cluster Name Enter the name of the cluster that hosts the JDBCProvider.
JDBCProviderName
Enter the name of the JDBCProvider.
Plugins Guide 55
Property Name Description
DataSource Name Enter the name of the datasource you want to create.
DataStore HelperClassName
Enter the ClassName of the DataStore Helper.
DB Name Enter the database name for the datasource.
JNDI Name Enter the JNDI name for the datasource.
Driver Type Enter the type of driver that is used by the datasource.
Server Name Enter the name of the server to which the datasource connects.
Port Number Enter the server's port number.
Auth Alias Enter the auth alias to create or use for the datasource.
Alias Username Enter the username for the Auth Alias if it does not already exist.
Alias Password Enter the password for the Auth Alias if it does not already exist.
Description Enter a description for the datasource.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Part 2: Application Server Management Plugins
56 Deployment Automation
Creating a WebSphere Create JDBCProvider StepUse this step to create a JDBCProvider with specified scope.
Required properties:
PropertyName
Description
Name Enter the name for your Create JDBCProvider step.
ConnectionType
Select the Connection Type to use with wsadmin. The default valueis "SOAP". Possible values are:
• SOAP
• RMI
• NONE
Scope Enter the scope at which to create the JDBCProvider in the format:type=name. The type can be a Cell, Node, Server, Application, orCluster, and name is a specific instance of the cell, node, server,application, or cluster that you are using.
DB Type Enter the database type of the JDBCProvider you want to create.
Provider Type Enter the provider type of the JDBCProvider you want to create.
ImplementationType
Enter the implementation type of the JDBCProvider.
Description Enter a description for the JDBCProvider.
Class Path Enter the class path of the JDBCProvider.
Native Path Enter the native path of the JDBCProvider.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
Plugins Guide 57
PropertyName
Description
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create aSIBJMSConnectionFactory StepUse this step to create a SIBJMSConnectionFactory on a give scope.
Required properties:
Property Name Description
Name Enter the name for your Create SIBJMSConnectionFactorystep.
Connection Type Select the Connection Type to use with wsadmin. Thedefault value is "SOAP". Possible values are:
• SOAP
• RMI
• NONE
Scope Enter the scope, which is the containment path to theparent on which to create this SIBJMSConnectionFactory.For example: /Cell:cellName/ServerCluster:clusterName/.
Note: The path must end with a "/".
SIBJMSConnectionFactoryName
Enter a name for the SIBJMSConnectionFactory you wantto create.
JNDI Name Enter a JNDI name for the factory you want to create.
Part 2: Application Server Management Plugins
58 Deployment Automation
Property Name Description
Bus Name Enter the name of the SIBus to associate with thisConnection Factory.
Type Enter the type of Connection Factory to create. Use Queue
or Topic.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Create SIBJMSQueue StepThis step will create a SIBJMSQueue on a given scope.
Required properties:
PropertyName
Description
Name Enter the name for your Create SIMJBSQueue step.
Plugins Guide 59
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Scope Enter the scope, which is the containment path to the parent on whichto create this SIBJMSQueue. For example: /Cell:cellName/ServerCluster:clusterName/.
Note: The path must end with a "/".
SIBJMSQueueName
Enter a SIBJMSQueue name for the queue you want to create.
JNDI Name Enter a JNDI name for the queue you want to create.
Queue Name Enter the queue name of the service integration bus destination towhich this queue maps.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Part 2: Application Server Management Plugins
60 Deployment Automation
PropertyName
Description
Port The port to connect to.
Creating a WebSphere Create SIBJMSTopic StepThis step will create a SIBJMSTopic on a given scope.
Required properties:
PropertyName
Description
Name Enter the name for your Create SIMJBSTopic step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Scope Enter the scope, which is the containment path to the parent on whichto create this SIBJMSTopic. For example: /Cell:cellName/ServerCluster:clusterName/.
Note: The path must end with a "/".
SIBJMSTopicName
Enter a SIBJMSTopic name for the topic you want to create.
JNDI Name Enter a JNDI name for the topic you want to create.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
Plugins Guide 61
PropertyName
Description
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Execute wsadmin Script StepThis step is used to execute a Jython of JACL script through wsadmin.
Required properties:
PropertyName
Description
Name Enter the name for your Execute wsadmin Script step.
Script Path Enter the script path to call wsadmin.
Language Enter the language for the script. Possible values are: Jython or JACL.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Part 2: Application Server Management Plugins
62 Deployment Automation
PropertyName
Description
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Export DataSource Propertiesfrom a Cluster StepThis step is used to export the datasource properties from a cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Export DataSource Properties from a Clusterstep.
Plugins Guide 63
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Cluster Name Enter the cluster name that hosts the JDBCProvider.
JDBCPRoviderName
Enter the name of the JDBCProvider for the datasource.
DataSourceName
Enter the name of the datasource from which to get properties.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Export JVMHeapSizes fromServer StepUse this step to export the JVM heap size values from a WebSphere server.
Part 2: Application Server Management Plugins
64 Deployment Automation
Required properties:
PropertyName
Description
Name Enter the name for your Export JVMHeapSizes from Server step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
ServerName
Enter the name of the server from which to export the heap size.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Export Application StepThis step is used to export an application from the WebSphere server.
Plugins Guide 65
Required properties:
PropertyName
Description
Name Enter the name of your Export Application step.
ApplicationName
Set the name of the application that you want to export. This is the nameused by WebSphere for reference.
File Path Set the path of the file to store. This must be expressed as an absolutepath.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Part 2: Application Server Management Plugins
66 Deployment Automation
PropertyName
Description
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Generate Plugin StepUse this step to generate a WebSphere plugin for WebServers to use.
Required properties:
Property Name Description
Name Enter the name of your Generate Plugin step.
Application ServerRoot Directory
Enter the path for the application server root directory.
Configuration RepoRoot Directory
Enter the root directory of the configuration repo were theplugin should be created
Connection Type Select the Connection Type to use with wsadmin. The defaultvalue is "SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Plugins Guide 67
PropertyName
Description
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Import DataSource Propertiesinto Cluster StepUse this step to import the datasource properties into a cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Import Datasource Properties into a Clusterstep.
Part 2: Application Server Management Plugins
68 Deployment Automation
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Cluster Name Enter the cluster name for the JDBCProvider.
JDBCPRoviderName
Enter the JDBCPRovider Name for the datasource.
DataSourceName
Enter the name of the datasource from which to get properties.
ConnectionTimeout
Enter the connection timeout to use.
StatementCache Size
Enter the statement cache size to use.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Plugins Guide 69
Creating a WebSphere Import JVMHeapSizes forCluster StepUse this step to import the JVM heap size values for all servers in a cluster.
Required properties:
PropertyName
Description
Name Enter the name for your Import JVMHeapSizes for Cluster step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Cluster Name Enter the name of the cluster to be updated.
Initial HeapSize
Enter the initial heap size to use for all servers in the cluster.
MaximumHeap Size
Enter the maximum heap size to use for all servers in the cluster.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Part 2: Application Server Management Plugins
70 Deployment Automation
PropertyName
Description
Port The port to connect to.
Creating a WebSphere Install Application StepThis step is used to install an application to the WebSphere server or cluster. It is wellsuited to installing an application to WebSphere for the first time.
Required properties:
PropertyName
Description
Name Enter the name for your Install or Install Application step.
Context Root Set the context root path for this application. Default is "/".
ApplicationSource
Set the location of the application to install to WebSphere.
ApplicationName
The name of the application you want to install. This is used forWebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Server Name Enter the name of the server to check.
MinimumSize (MB)
Enter the minimum expected heap size in MBs.
MaximumSize (MB)
Enter the maximum expected heap size in MBs.
Optional properties:
PropertyName
Description
ApplicationPath
The path for the application to be installed on the server.
Plugins Guide 71
PropertyName
Description
Options String The string of options to be concatenated onto the install command.
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Install or Update ApplicationStepThis step is used to install or update an existing application to the WebSphere server orcluster. It is suited to reinstalling an application over an existing application on theWebSphere server.
Part 2: Application Server Management Plugins
72 Deployment Automation
Required properties:
PropertyName
Description
Name Enter the name for your Install or Update Application step.
Context Root Set the context root path for this application. Default is "/".
ApplicationSource
Set the location of the application to install to WebSphere.
ApplicationName
The name of the application you want to install. This is used forWebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Server Name Enter the name of the server to check.
MinimumSize (MB)
Enter the minimum expected heap size in MBs.
MaximumSize (MB)
Enter the maximum expected heap size in MBs.
Optional properties:
PropertyName
Description
ApplicationPath
The path for the application to be installed on the server.
Options String The string of options to be concatenated onto the install command.
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Plugins Guide 73
PropertyName
Description
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Modify Application ClassLoadersStepUse this step if you need to modify the classloaders for an application and itswebmodules.
Required properties:
PropertyName
Description
Name Enter the name for your Modify Application ClassLoaders step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Part 2: Application Server Management Plugins
74 Deployment Automation
Optional properties:
PropertyName
Description
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
ApplicationName
The name of the application for which to update classloaders.
ApplicationClassLoader
PARENT_FIRST or PARENT_LAST. The Classloader mode to use forthe overall application. The default value is PARENT_FIRST.
WebModuleClassLoader
PARENT_FIRST or PARENT_LAST. The Classloader mode to use forthe webmodules in the given application. The default value isPARENT_FIRST.
AdditionalCommandLineArguments
New line separated list of additional commandline arguments to passto wsadmin. These will be appended as the last arguments of thecommand line.
Creating a WebSphere Restart Application StepThis step is used to restart an application on the WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Restart Application step.
Plugins Guide 75
PropertyName
Description
ApplicationName
Set the name of the application that you want to restart. This is thename used for WebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Part 2: Application Server Management Plugins
76 Deployment Automation
PropertyName
Description
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Restart Server StepThis step is used to restart a WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Restart Server step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
Plugins Guide 77
PropertyName
Description
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Start Application StepThis step is used to start an application on the WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Start Application step.
ApplicationName
Set the name of the application that you want to start. This is the nameused for WebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Part 2: Application Server Management Plugins
78 Deployment Automation
PropertyName
Description
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Start Server StepThis step is used to start a WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Start Server step.
Plugins Guide 79
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Part 2: Application Server Management Plugins
80 Deployment Automation
Creating a WebSphere Stop Application StepThis step is used to stop an application on the WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Stop Application step.
ApplicationName
Set the name of the application that you want to stop. This is the nameused for WebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Plugins Guide 81
PropertyName
Description
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Stop Server StepThis step is used to stop a WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Stop Server step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Part 2: Application Server Management Plugins
82 Deployment Automation
PropertyName
Description
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Synchronize Nodes StepUse this step to synchronize all nodes in the WebSphere cell.
Required properties:
PropertyName
Description
Name Enter the name for your Synchronize Nodes step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Plugins Guide 83
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Uninstall Application StepThis step is used to uninstall an application from the WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Uninstall Application step.
ApplicationName
Set the name of the application that will be uninstalled. This is the nameused for WebSphere reference.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Part 2: Application Server Management Plugins
84 Deployment Automation
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Update J2EEResourcePropertyon a Config Object StepThis step is used to create or update a J2EEResourceProperty on a config object.
Plugins Guide 85
Required properties:
PropertyName
Description
Name Enter the name for your Update J2EEResourceProperty on a ConfigObject step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
ObjectContainmentPath
Enter the path to the object on which to update a property. Forexample: /Cell:cellName/ServerCluster:clusterName/.
Note: The path must end with a "/".
PropertyName
Enter the name of the property you want to update.
Value Enter the value for the property.
Type Enter the type of the property.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Part 2: Application Server Management Plugins
86 Deployment Automation
PropertyName
Description
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Update Simple Attribute onObject StepUse this step to update a simple attribute on a config object.
Required properties:
PropertyName
Description
Name Enter the name for your Update Simple Attribute on Object step.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
ObjectContainmentPath
Enter the path to the object on which to update an attribute. Forexample: /Cell:cellName/ServerCluster:clusterName/.
Note: The path must end with a "/".
AttributeName
Enter the name of the attribute you want to update.
Value Enter the value for the attribute.
Plugins Guide 87
Optional properties:
PropertyName
Description
CommandPath
The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
UserName
The user name to be used to connect to the WebSphere Node. The defaultvalues is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
Creating a WebSphere Update Application StepThis step is used to update an application on the WebSphere server or cluster.
Required properties:
PropertyName
Description
Name Enter the name of your Install Application step.
ApplicationName
Set the name of the application that is being updated. This is the nameused for WebSphere reference.
ContentType
Set the content type for the update. Possibile values are:
• Application
• File
• Module File
• Partial Application
Part 2: Application Server Management Plugins
88 Deployment Automation
PropertyName
Description
Operation Set the operation to be performed during this update. (If this is anapplication update or a partial application update, you must enterUpdate.) Possible values are:
• Update
• Add
• Delete
• Add or Update
ContentPath
Set the location of the contents that will update the application.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Content URI If the content type is File, this should be the location of the file to beupdated, relative to the EAR root.
Options String The string of options to be concatenated onto the update command.
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Plugins Guide 89
PropertyName
Description
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a WebSphere Wait for Application StepThis step is used to create a wait step while a WebSphere server or cluster becomesready.
Required properties:
PropertyName
Description
Name Enter the name of your Wait for Application step.
ApplicationName
Set the name of the application to wait for.
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Part 2: Application Server Management Plugins
90 Deployment Automation
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Creating a Websphere Wait for Server or Cluster StepUse this step to build in a wait period for a WebSphere server or cluster to be started.
Required properties:
PropertyName
Description
Name Enter the name of your Wait for Server or Cluster step.
Plugins Guide 91
PropertyName
Description
ConnectionType
Select the Connection Type to use with wsadmin. The default value is"SOAP". Possible values are:
• SOAP
• RMI
• NONE
Optional properties:
PropertyName
Description
Cell Name The name of the cell to be administered. The default value is:${p:resource/websphere.cell}.
Node Name The name of the node to be administered. The default value is:${p:resource/websphere.node}.
Server Name The name of the server to be administered.
Cluster Name The name of the cluster to be administered.
Command Path The directory location of the wsadmin command-line executable. Forexample:
/opt/IBM/WebSphere/AppServer/bin/
The default value is: ${p:resource/websphere.commandPath}.
User Name The user name to be used to connect to the WebSphere Node. Thedefault values is ${p:resource/websphere.user}.
Password The password to be used to connect to the WebSphere Node.
Password Script If you wish to use a script or property lookups for your password,leave the Password field blank and enter it here.
Host Hostname of the server to connect to.
Port The port to connect to.
AdditionalCommand LineArguments
New line separated list of additional command line arguments topass to wsadmin. These will be appended as the last arguments ofthe command line.
Part 2: Application Server Management Plugins
92 Deployment Automation
Chapter 6: IBM WebSphere MB Plugin
The IBM WebSphere Message Broker (WebSphere MB) API is also known as theConfiguration Manager Proxy (CMP) or CMP API. The CMP API consists of a Javaimplementation and allows applications to control brokers and their resources.
WebSphere MB can translate messages between two devices using different protocols forcommunication. This allows heterogeneous applications to communicate without having toknow specific implementation details about the application with which they are trying tocommunicate.
The WebSphere MB plugin enables you to deploy broker archives and start and stopmessage flows using the CMP API.
In the Process Editor Available Plugin Steps, navigate to Middleware > EnterpriseService Bus > WebSphere Message Broker.
This plugin has the following steps for you to add to your processes:
• Creating a WebSphere WMB Set Broker Properties Step [page 93]
• Creating a WebSphere WMB Set Execution Group Properties Step [page 94]
• Creating a WebSphere WMB Set Message Flows Property Step [page 95]
• Creating a WebSphere WMB Delete Flows Using RegEx Step [page 96]
• Creating a WebSphere WMB Deploy Step [page 97]
• Creating a WebSphere WMB Start Message Flows Step [page 98]
• Creating a WebSphere WMB Stop Message Flows Step [page 99]
For information about WebSphere MB, see http://www-03.ibm.com/software/products/us/en/integration-bus.
Creating a WebSphere WMB Set Broker Properties StepThis step sets runtime properties for the broker.
Required properties:
PropertyName
Description
Properties A newline-separated list of properties that you want to set, provided inname=value format.
IP The IP address of the target server.
Port The port of the target server.
Plugins Guide 93
PropertyName
Description
QueueManager
The WebSphere Queue Manager that the broker is using.
Optional properties:
PropertyName
Description
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Set Execution GroupProperties StepThis step sets runtime properties for an execution group.
Required properties:
PropertyName
Description
ExecutionGroup
The name of the Execution Group to deploy to.
Properties A newline-separated list of properties that you want to set, provided inname=value format.
IP The IP address of the target server.
Port The port of the target server.
QueueManager
The WebSphere Queue Manager that the broker is using.
Part 2: Application Server Management Plugins
94 Deployment Automation
Optional properties:
PropertyName
Description
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Set Message FlowsProperty StepThis step sets runtime properties on a list of message flow.
Required properties:
Property Name Description
Execution Group The name of the Execution Group to deploy to.
IP The IP address of the target server.
Port The port of the target server.
Queue Manager The WebSphere Queue Manager that the broker is using.
Optional properties:
PropertyName
Description
DirectoryOffset
The path under the current working directory where the step shouldexecute. Absolute paths are not allowed.
MessageFlows
A newline-separated list of message flows.
Properties A newline-separated list of properties that you want to set, provided inname=value format.
Plugins Guide 95
PropertyName
Description
PropertyFile
The name and path to a property file that contains the properties. Thiscan be used instead of explicitly providing all the properties in theProperties field and the flows in the Message Flows field. You mustspecify the property file in the same format as the mqsiapplybaroverridecommand.
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Delete Flows Using RegExStepThis step deletes WMB flows that have been deployed using the BAR file that matches aprovided regular expression. This is useful for deploying into shared execution groups.
Required properties:
PropertyName
Description
RegEx A Java compliant regular expression that is used to locate the correct BARfile of deployed flows by matching its filename.
ExecutionGroup
The name of the Execution Group to deploy to.
IP The IP address of the target server.
Port The port of the target server.
QueueManager
The WebSphere Queue Manager that the broker is using.
Part 2: Application Server Management Plugins
96 Deployment Automation
Optional properties:
PropertyName
Description
Timeout The amount of time to wait for each BAR file deploy result to come return(in milliseconds). The default value is 60000.
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Deploy StepThis step deploys a broker archive.
Required properties:
Property Name Description
BAR File Names A comma-separated list of broker archive files to deploy.
Execution Group The name of the Execution Group to deploy to.
IP The IP address of the target server.
Port The port of the target server.
Queue Manager The WebSphere Queue Manager that the broker is using.
Optional properties:
PropertyName
Description
Value forFullDeploy
If selected, the execution group is emptied before deploy.
Timeout The amount of time to wait for each BAR file deploy result to come return(in milliseconds). The default value is 60000.
Plugins Guide 97
PropertyName
Description
Value forStart/StopMessageFlows
If selected, all message flows in the execution group are stopped beforedeployment and started after deployment.
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Start Message Flows StepThis step starts message flows that are stopped.
Required properties:
Property Name Description
Execution Group The name of the execution group.
IP The IP address of the target server.
Port The port of the target server.
Queue Manager The WebSphere Queue Manager that the broker is using.
Optional properties:
PropertyName
Description
MessageFlows
A newline-separated list of message flow names to start.
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Part 2: Application Server Management Plugins
98 Deployment Automation
PropertyName
Description
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Creating a WebSphere WMB Stop Message Flows StepThis step stops message flows that are running.
Required properties:
Property Name Description
Execution Group The name of the execution group.
IP The IP address of the target server.
Port The port of the target server.
Queue Manager The WebSphere Queue Manager that the broker is using.
Optional properties:
PropertyName
Description
MessageFlows
A newline-separated list of message flow names to stop.
Username Specify an alternate username for authentication against WMQ in case thestep is running as an invalid user.
Trace File Used to specify the trace logging file. If no value is supplied, then tracelogging is disabled.
Jar Path The full path that contains both the ConfigManagerProxy.jar and thecom.ibm.mq.jar. For example: C:\ProgramFiles\IBM\MQSI\7.0\classes\ConfigManagerProxy.jar:C:\ProgramFiles\IBM\WebSphere MQ\java lib\com.ibm.mq.jar
Plugins Guide 99
Part 2: Application Server Management Plugins
100 Deployment Automation
Chapter 7: IBM WebSphere MQ
The IBM WebSphere Message Queuing enables multiple heterogeneous applications tocommunicate across a network of dissimilar components such as processors, operatingsystems, subsystems, and communication protocols, using a consistent API so that themessage delivery process is decoupled from the actual application. Any type of data canbe transported as messages.
In the Process Editor Available Plugin Steps, navigate to Middleware > Messaging >WebSphereMQ.
This plugin has the following steps for you to add to your processes:
• Creating a WebSphere Create Queue Manager Step [page 101]
• Creating a WebSphere Manage Queue Depth Step [page 102]
• Creating a WebSphere Start Queue Manager Step [page 102]
• Creating a WebSphere Stop Queue Manager Step [page 103]
• Creating a WebSphere Define Queue Step [page 103]
• Creating a WebSphere Run MQ Script Step [page 104]
For information about WebSphere MQ, see http://www-01.ibm.com/software/websphere/.
Creating a WebSphere Create Queue Manager StepThis step runs the executable to create a Queue Manager.
Required properties:
PropertyName
Description
QueueName
The name of the queue manager you want to create.
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Optional properties:
PropertyName
Description
QueueDescription
Descriptive text for the Queue Manager that is being created. Themaximum description length is 64 characters.
Plugins Guide 101
PropertyName
Description
AdditionalArguments
Any additional arguments for the Create Queue Manager command.
Creating a WebSphere Manage Queue Depth StepThis step manages the queue depth.
Required properties:
PropertyName
Description
QueueManagerName
The name of the queue manager you want to edit.
Queue Name The name of the queue you want to edit.
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Optional properties:
Property Name Description
High Depth Level The percentage of a Queue depth that constitutes "high".
Low Depth Level The percentage of a Queue depth that constitutes "low".
Max Depth Level The maximum number of messages in the queue.
AdditionalArguments
Any additional arguments for the Manage Queue Depthcommand.
Creating a WebSphere Start Queue Manager StepThis step starts a queue manager.
Part 2: Application Server Management Plugins
102 Deployment Automation
Required properties:
PropertyName
Description
QueueManagerName
The name of the queue manager you want to start.
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Optional properties:
Property Name Description
AdditionalArguments
Any additional arguments for the Create Queue Managercommand.
Note: The queue manager must be created before it can be started.
Creating a WebSphere Stop Queue Manager StepThis step stops a queue manager.
Required properties:
PropertyName
Description
QueueManagerName
The name of the queue manager you want to stop.
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Optional properties:
Property Name Description
AdditionalArguments
Any additional arguments for the Create Queue Managercommand.
Creating a WebSphere Define Queue StepThis step defines a queue.
Plugins Guide 103
Required properties:
PropertyName
Description
QueueManagerName
The name of the queue manager that you want to use to define aqueue.
Queue Name The name of the queue that you want to define.
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Optional properties:
Property Name Description
AdditionalArguments
Any additional arguments for the Create Queue Managercommand.
Note: The queue manager must be created before a queue can be created.
Creating a WebSphere Run MQ Script StepThis step runs a custom MQ script that consists of MQ Control commands.
Required properties:
PropertyName
Description
QueueManagerName
The name of the queue manager on which to run the script.
Script Data The script to be run. Enter the actual commands that the script mustrun. For example: DISPLAY QUEUE ('My Queue').
CommandDirectory
Directory of the WebSphere MQ commands. For example: C:\ProgramFiles (x86)\IBM\WebSphere MQ\bin.
Part 2: Application Server Management Plugins
104 Deployment Automation
Optional properties:
Property Name Description
AdditionalArguments
Any additional arguments for the Create Queue Managercommand.
Plugins Guide 105
Part 2: Application Server Management Plugins
106 Deployment Automation
Chapter 8: JBoss Plugin
JavaBeans Open Source Software (JBoss) is an open-source application server thatimplements Java EE.
The JBoss plugins automate a number of operations for a JBoss server. There are JBossplugins for JBoss 6 and earlier and JBoss 7. Load the plugin that supports the version ofJBoss you are working with.
JBoss 7In the Process Editor Available Plugin Steps, navigate to Application Server > Java> JBoss 7.
This plugin has the following steps for you to add to your processes:
• Creating an Add Data Source Step [page 108]
• Creating an Add JMS Connection Factory Step [page 109]
• Creating an Add JMS Queue Step [page 110]
• Creating an Add JMS Topic Step [page 110]
• Creating a Check Deployment Status Step [page 111]
• Creating a Create Server Group Step [page 111]
• Creating a Deploy Application Step [page 112]
• Creating a Deploy JDBC Driver Step [page 113]
• Creating a Disable Application Step [page 113]
• Creating an Enable Application Step [page 114]
• Creating an Enable Data Source Step [page 115]
• Creating a Remove JMS Connection Factory Step [page 115]
• Creating a Remove JMS Queue Step [page 116]
• Creating a Remove JMS Topic Step [page 116]
• Creating a Run Script Step [page 117]
• Creating a Start JBoss Step [page 117]
• Creating a Start Server Step [page 118]
• Creating a Start Server Group Step [page 119]
• Creating a Stop JBoss Step [page 119]
Plugins Guide 107
• Creating a Stop Server Step [page 119]
• Creating a Stop Server Group Step [page 120]
• Creating an Undeploy Application Step [page 120]
JBoss 6 and earlierIn the Process Editor Available Plugin Steps, navigate to Application Server > Java> JBoss 6 and earlier.
This plugin has the following steps for you to add to your processes:
• Check Status
• Start and wait
• Stop and wait
For information about JBoss, see http://www.jboss.org/jbossas.
Creating an Add Data Source StepThis step stops JBoss in either Standalone or Domain mode.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location
Add as XASource
Select to create this Data Source as an XA Data Source.
Data SourceName
Name of the Data Source to be created
JNDI Name The JNDI name for the Data Source. This name must begin withjava:/ or java:jboss/.
Driver Name Name of the driver to be used for this connection.
ConnectionURL
For use with non-XA Data Sources. The connection URL to thedatabase to be used.
User Name The user name for the database to be used.
Password The password for the database to be used.
Server Name Required for XA Data Sources. The name of the server for the XA DataSource.
Part 2: Application Server Management Plugins
108 Deployment Automation
PropertyName
Description
Port Number Required for XA Data Sources. The port number of the server.
DatabaseName
Required for XA Data Sources.
Optional properties:
Property Name Description
Add Enabled Select to enable on creation. Leave unselected to enable later.
Profile The profile to add the Data Source to.
AdditionalProperties
Additional properties to pass to the command, new-lineseparated.
Controller Name The controller name of the JBoss instance to connect to.
Creating an Add JMS Connection Factory StepThis step adds a JMS topic to JBoss.
Required properties:
PropertyName
Description
JBossPath
The path to the JBoss location
FactoryName
The name of the factory to be created.
Entries The JNDI names the factory will be bound to, comma separated. Theentries must end with the name of the factory.
Connector The connector to be used, comma separated. The first will be the default,the rest will be backups.
Optional properties:
Property Name Description
Profile The profile to add the topic to. This is required in Domain mode.
Plugins Guide 109
Property Name Description
AdditionalProperties
Additional properties to pass to the command, new-lineseparated.
Controller Name The controller name of the JBoss instance to connect to.
Creating an Add JMS Queue StepThis step adds a JMS Queue to JBoss.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location
Queue Name The name (address) of the queue to be created.
Entries A comma-separated list of JNDI names that the queue will be boundto.
Optional properties:
Property Name Description
Queue Selector The queue selector.
Durable Select to make the queue durable.
Profile The profile to add the queue to. This is required in Domain mode.
Controller Name The controller name of the JBoss instance to connect to.
Creating an Add JMS Topic StepThis step adds a JMS topic to JBoss.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location
Topic Name The name (address) of the topic to be created.
Part 2: Application Server Management Plugins
110 Deployment Automation
PropertyName
Description
Entries A comma-separated list of JNDI names that the topic will be boundto.
Optional properties:
Property Name Description
Profile The profile to add the topic to. This is required in Domain mode.
Controller Name The controller name of the JBoss instance to connect to.
Creating a Check Deployment Status StepThis step gets the status information on a deployment.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location.
DeploymentName
The name of the deployment to check (the filename and extension).
Host Name The name of the host for the deployment. This is required in Domainmode.
Server Name The name of the server for the deployment. This is required inDomain mode.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating a Create Server Group StepThis step creates a server group on a JBoss domain instance.
Plugins Guide 111
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Server Group Name The server group to create this server group under.
Profile The profile to create this server group under.
Socket BindingGroup
The name of the socket binding group to use for the servergroup.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating a Deploy Application StepThis step deploys an application to JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Optional properties:
PropertyName
Description
ApplicationPath
The source file of the application to deploy. If no source is specified, aname must be specified.
ApplicationName
The name of the application to be deployed. If no source is specified,the named application will be enabled instead.
ForceDeployment
This switch will force the replacement of the existing deployment. Itcan’t be used if Deploy in Disabled State is selected.
Deploy inDisabledState
Indicates that the deployment has to be added to the repositorydisabled.
Part 2: Application Server Management Plugins
112 Deployment Automation
PropertyName
Description
All ServerGroups
If selected, the step will deploy to all servers. This is only applicable inDomain mode.
ServerGroups
A comma-separated list of the servers to deploy to. This is onlyapplicable in Domain mode.
ControllerName
The controller name of the JBoss instance to connect to.
Creating a Deploy JDBC Driver StepThis step deploys a JDBC driver to JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
JDBC Driver Path The path to the JDBC driver JAR.
Optional properties:
PropertyName
Description
DriverName
The name of the driver. If no name is specified, the file name (including.jar) will be the name.
All ServerGroups
If selected, the step will deploy to all servers. This is only applicable inDomain mode.
ServerGroups
A comma-separated list of the servers to deploy to. This is onlyapplicable in Domain mode.
ControllerName
The controller name of the JBoss instance to connect to.
JAVA_HOME The JDK or JRE in which to run JBoss commands. This JBoss versionsupports only Java 6 and 7!
Creating a Disable Application StepThis step disables a standalone application that has been deployed to JBoss.
Plugins Guide 113
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location.
ApplicationName
The name of the application to be disabled. If a source is not provided,the named application will be disabled instead.
Optional properties:
PropertyName
Description
All ServerGroups
Only applicable in Domain mode. Check to disable the application on allserver groups.
ServerGroups
Only applicable in Domain mode. List the server groups you'd like todisable the application on, comma separated.
ControllerName
The controller name of the JBoss instance to connect to.
Creating an Enable Application StepThis step enables an application that has been deployed to JBoss (Standalone mode only).
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Application Name The name of the application to be enabled.
Optional properties:
PropertyName
Description
All ServerGroups
Only applicable in Domain mode. Check to enable the application on allserver groups.
ServerGroups
Only applicable in Domain mode. List the server groups you'd like toenable the application on, comma separated.
Part 2: Application Server Management Plugins
114 Deployment Automation
PropertyName
Description
ControllerName
The controller name of the JBoss instance to connect to.
Creating an Enable Data Source StepEnable a new Data Source in JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location
Data Source Name Name of the Data Source to be enabled
Optional properties:
Property Name Description
Add as XA Source Select to create this Data Source as an XA Data Source.
Persistent Select to persist the enable attribute.
Profile The profile to add the Data Source to.
Controller Name The controller name of the JBoss instance to connect to.
Creating a Remove JMS Connection Factory StepThis step removes a JMS connection factory from JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location
Factory Name The name of the factory that you want to remove.
Plugins Guide 115
Optional properties:
PropertyName
Description
Profile The profile to remove the factory from. This is required in Domainmode.
ControllerName
The controller name of the JBoss instance to connect to.
Creating a Remove JMS Queue StepThis step removes a JMS queue from JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Queue Name The name (address) of the queue to be removed.
Optional properties:
Property Name Description
Profile The profile to remove the queue from. Required in Domain mode.
Controller Name The controller name of the JBoss instance to connect to.
Creating a Remove JMS Topic StepThis step removes a JMS topic from JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Topic Name The name (address) of the topic to be removed.
Part 2: Application Server Management Plugins
116 Deployment Automation
Optional properties:
PropertyName
Description
Profile The profile to remove the topic from. Required if JBoss is in Domainmode.
ControllerName
The controller name of the JBoss instance to connect to.
Creating a Run Script StepThis step runs a custom script on JBoss using the CLI.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Script Data The script to be executed.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Note: For information on available commands, run this step with the followingscript: help --commands.
Creating a Start JBoss StepThis step starts JBoss in either Standalone or Domain mode.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location.
OperatingMode
Choose whether to start in Standalone or Domain mode.
Server StartWait Timeout
The amount of time (in milliseconds) to wait for the server to startbefore declaring timeout. The default value is 10000.
Plugins Guide 117
PropertyName
Description
Host Name The host name of the server to be started.
Port Number The port number of the server to be started.
Optional properties:
PropertyName
Description
ServerConfiguration
Enter a file name to start the server according to a specificconfiguration.
HostConfiguration
Only applicable in Domain mode. Provide a file name to start theserver with a specific configuration.
AdditionalProperties
Additional properties to pass to the CLI, new-line separated.
JAVA_HOME The JDK or JRE to run JBoss. This JBoss version supports only Java 6and 7!
JAVA_OPTS Specific options for the JVM to start with.
Creating a Start Server StepThis step starts a server on a JBoss domain instance.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Host Name The name of the server host.
Server Name The name of the server to be started.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Part 2: Application Server Management Plugins
118 Deployment Automation
Creating a Start Server Group StepThis step starts a server group on a JBoss domain instance.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Server Group Name The name of the server group to be started.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating a Stop JBoss StepThis step stops JBoss in either Standalone or Domain mode.
Required properties:
PropertyName
Description
JBoss Path The path to the JBoss location.
OperatingMode
Choose whether your server is in Standalone or Domain mode.
HostName
The name of the host. This is required only when the server is in DomainMode. The default value is master.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating a Stop Server StepThis step stops a server on a JBoss domain instance.
Plugins Guide 119
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Host Name The name of the server host.
Server Name The name of the server to be stopped.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating a Stop Server Group StepThis step stops a server group on a JBoss domain instance.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Server Group Name The name of the server group to be stopped.
Optional properties:
Property Name Description
Controller Name The controller name of the JBoss instance to connect to.
Creating an Undeploy Application StepThis step undeploys an application in JBoss.
Required properties:
Property Name Description
JBoss Path The path to the JBoss location.
Application Name The name of the application to be undeployed.
Part 2: Application Server Management Plugins
120 Deployment Automation
Optional properties:
PropertyName
Description
KeepContent
Select to keep the content on your JBoss server. This will deactivate theapplication, but will not delete anything.
All ServerGroups
Only applicable in Domain mode. Check to undeploy from all relevantservers.
ServerGroups
Only applicable in Domain mode. List the servers you'd like to undeployfrom, comma separated.
ControllerName
The controller name of the JBoss instance to connect to.
Plugins Guide 121
Part 2: Application Server Management Plugins
122 Deployment Automation
Chapter 9: IIS AdminScripts Plugin
Microsoft IIS is a web server application packaged with Windows Server for hostingwebsites, services, and applications. The IIS AdminScripts plugin enables you to automateIIS configuration changes during a deployment.
In the Process Editor Available Plugin Steps, navigate to Application Server > IIS >IIS AdminScripts.
This plugin has the following steps for you to add to your processes:
• Creating an AdsUtil Step [page 123]
• Creating an Update WebSiteProperties Step [page 124]
• Creating an Update VDirProperties Step [page 124]
• Creating a Set .Net Version Step [page 124]
For information about IIS, see http://www.iis.net/home.
Creating an AdsUtil StepThis step runs an arbitrary adsutil command.
Required properties:
Property Name Description
Command The command to run using adsutil.
Optional properties:
PropertyName
Description
Path The path of the node for which you are setting the property, combinedwith the name of the property you are setting. For example: w3svc/1/ServerComment.
Parameters A newline-separated list of parameters to be set if needed for thecommand.
AdsUtil.vbsPath
The path to the AdsUtil.vps executable including the file name. Forexample: C:\InetPub\AdminScripts\adsutil.vbs.
CscriptPath
The path to the cscript.exe executable including the file name if not onthe path. For example: C:\Windows\system32\cscript.exe.
Plugins Guide 123
Creating an Update WebSiteProperties StepThis step sets properties on a website.
Required properties: None
Optional properties:
PropertyName
Description
Website The website name.
Parameters A newline-separated list of parameters to be set using the syntaxname=value.
Note: “=” is not valid as part of the name
Creating an Update VDirProperties StepThis step sets properties on a virtual directory.
Required properties:
PropertyName
Description
VDirOffset
The offset from the website path to the virtual directory. For example, witha virtual directory named test, the value would be /root/test. Thedefault virtual directory is /root.
Optional properties:
PropertyName
Description
Website The website name.
Parameters A newline-separated list of parameters to be set using the syntaxname=value.
Note: “=” is not valid as part of the name
Creating a Set .Net Version StepThis step sets the .NET version for a website.
Part 2: Application Server Management Plugins
124 Deployment Automation
Required properties:
PropertyName
Description
Version The version of .NET to set. The .NET framework for this version must beinstalled, and it must contain the aspnet_regiis executable in%windir%\microsoft.net\framework\${version}. You must select oneof the following values:
• 2.0
• 1.1
Optional properties:
Property Name Description
Website The website name.
Plugins Guide 125
Part 2: Application Server Management Plugins
126 Deployment Automation
Chapter 10: IIS AppCmd Plugin
Microsoft IIS is a web server application packaged with Windows Server for hostingwebsites, services, and applications.
AppCmd.exe is a command line tool for managing IIS 7 and above. The IIS AppCmd pluginenables you to configure and query objects on a web server and to return output in textor XML among other things.
In the Process Editor Available Plugin Steps, navigate to Application Server > IIS >IIS AppCmd.
This plugin has the following steps for you to add to your processes:
• Creating a Create Application Step [page 127]
• Creating a Delete Application Step [page 128]
• Creating a Create Site Step [page 128]
• Creating a Delete Site Step [page 129]
• Creating a Start Site Step [page 129]
• Creating a Stop Site Step [page 130]
• Creating a Check if Site Exists Step [page 130]
• Creating a Check if Site is Stopped Step [page 131]
• Creating a Check if Site is Running Step [page 131]
• Creating a Create Virtual Directory Step [page 132]
• Creating a Delete Virtual Directory Step [page 132]
• Creating a Create Application Pool Step [page 133]
• Creating a Delete Application Pool Step [page 133]
• Creating a Start Application Pool Step [page 134]
• Creating a Stop Application Pool Step [page 134]
• Creating a Recycle Application Pool Step [page 135]
• Creating an AppCmd Step [page 135]
For information about IIS, see http://www.iis.net/home.
Creating a Create Application StepThis step creates an application in IIS.
Plugins Guide 127
Required properties:
PropertyName
Description
Parent Site The parent site the application should be created under. For example:Default Web Site.
Virtual Path The virtual path under which the application should be created.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrc\.
Creating a Delete Application StepThis step deletes an application in IIS.
Required properties:
PropertyName
Description
ID The application path or URL of the application to delete. For example:Default Web Site/Application.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Create Site StepThis step creates a new website in IIS.
Part 2: Application Server Management Plugins
128 Deployment Automation
Required properties:
Property Name Description
Site Name The name of the website to create. For example: DefaultWebSite.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Delete Site StepThis step deletes a website in IIS.
Required properties:
Property Name Description
Site Name The name of the website to delete. For example: DefaultWebSite.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Start Site StepThis step starts a website in IIS.
Required properties:
Property Name Description
Site Name The name of the website to start. For example: DefaultWebSite.
Plugins Guide 129
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Stop Site StepThis step stops a website in IIS.
Required properties:
Property Name Description
Site Name The name of the website to stop. For example: DefaultWebSite.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Check if Site Exists StepThis step checks to see if a website exists in IIS.
Required properties:
Property Name Description
Site Name The name of the website to check. For example: DefaultWebSite.
Part 2: Application Server Management Plugins
130 Deployment Automation
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Check if Site is Stopped StepThis step checks to see if a website is stopped in IIS.
Required properties:
Property Name Description
Site Name The name of the website to check. For example: DefaultWebSite.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Check if Site is Running StepThis step checks to see if a website is running in IIS.
Required properties:
Property Name Description
Site Name The name of the website to check. For example: DefaultWebSite.
Plugins Guide 131
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Create Virtual Directory StepThis step creates a virtual directory in IIS.
Required properties:
PropertyName
Description
ParentApplication
Application identifier under which this virtual directory should be created.This refers to the application pool name followed by the applicationname.
VirtualPath
The virtual path of the virtual directory.
Optional properties:
PropertyName
Description
Path The physical path of the virtual directory.
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Delete Virtual Directory StepThis step deletes a virtual directory in IIS.
Part 2: Application Server Management Plugins
132 Deployment Automation
Required properties:
PropertyName
Description
VirtualDirectory Path
The virtual directory path or URL to be deleted. For example:Default Web Site/subdir.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Create Application Pool StepThis step creates a new application pool in IIS.
Required properties:
Property Name Description
Application Pool Name The name of the application pool that you want to create.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Delete Application Pool StepThis step deletes an application pool in IIS.
Plugins Guide 133
Required properties:
Property Name Description
Application Pool Name The name of the application pool that you want to delete.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Start Application Pool StepThis step starts an application pool in IIS.
Required properties:
Property Name Description
Application Pool Name The name of the application pool that you want to start.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Stop Application Pool StepThis step stops an application pool in IIS.
Required properties:
Property Name Description
Application Pool Name The name of the application pool that you want to stop.
Part 2: Application Server Management Plugins
134 Deployment Automation
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating a Recycle Application Pool StepThis step recycles an application pool in IIS.
Required properties:
Property Name Description
Application Pool Name The name of the application pool that you want to recycle.
Optional properties:
PropertyName
Description
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Creating an AppCmd StepThis step runs an arbitrary appcmd command.
Required properties:
Property Name Description
Command The command to run using appcmd.
Object Type The object type that the command should run against.
Plugins Guide 135
Optional properties:
PropertyName
Description
Identifier The identifier for the object, if required.
Arguments A newline-separated list of arguments to be added to the appcmd call.For example: /arg1:val1\n/arg2:val2\n/arg3:val3…
CommandPath
The directory location of the AppCmd command-line executable. Forexample: C:\Windows\system32\inetsrv\.
Part 2: Application Server Management Plugins
136 Deployment Automation
Chapter 11: Microsoft IIS MS-DeployPlugin
Microsoft IIS is a web server application packaged with Windows Server for hostingwebsites, services, and applications.
IIS MSDeploy, also known as Web Deploy, enables you to:
• Deploy Web applications and websites to IIS servers
• Detect differences between source and destination content
• Synchronize IIS servers
It makes it easier to:
• Move servers to newer versions of IIS
• Backup servers
The MSDeploy plugin automates:
• Synchronizing and deleting servers, sites, applications, and packages
• Starting, stopping, and recycling application pools through the MSDeploy application
In the Process Editor Available Plugin Steps, navigate to Application Server > IIS >IIS MSDeploy.
This plugin has the following steps for you to add to your processes:
• Creating a Synchronize Step [page 137]
• Creating an MSDeploy Step [page 139]
• Creating a Delete Step [page 140]
• Creating a Stop Application Step [page 141]
• Creating a Recycle Application Step [page 142]
For information about IIS, see http://www.iis.net/home.
Creating a Synchronize StepThis step synchronizes two IIS objects.
Plugins Guide 137
Required properties:
PropertyName
Description
Source ProviderType
The provider type for the source argument of the synchronize.Select a value from the list below.
• Application
• Archive Directory
• ContentPath
• Directory
• File
• Manifest
• MetaKey
• Package
• Server
• Server 6.0
• Site
Provider Source The provider path and setting for the source. Use the syntax:path,setAting1,settign2….
Part 2: Application Server Management Plugins
138 Deployment Automation
PropertyName
Description
DestinationProvider Type
The provider type for the destination argument of the synchronize.Select a value from the list below.
• Auto
• Application
• Archive Directory
• ContentPath
• Directory
• File
• Manifest
• MetaKey
• Package
• Server
• Server 6.0
• Site
Optional properties:
PropertyName
Description
ProviderDestination
The Provider path and setting for the destination provided using thesyntax path,setting1,setting2….
OptionsString
A newline-separated list of arguments to concatenate onto thesynchronize command. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.
CommandPath
The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.
Creating an MSDeploy StepThis step runs an msdeploy command.
Plugins Guide 139
Required properties:
Property Name Description
Verb The verb (operation) to be performed by msdeploy.
Optional properties:
PropertyName
Description
SourceProviderType
The provider type for the source argument of the command. This isrequired if the provider source is supplied.
ProviderSource
The provider path and setting for the source given in the syntaxpath,setting1,setting2….
DestinationProviderType
The provider type for the destination argument of the command.
ProviderDestination
The provider path and setting for the destination provided using thesyntax path,setting1,setting2….
OptionsString
A newline-separated list of arguments to concatenate onto thesynchronize command. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.
CommandPath
The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.
Creating a Delete StepThis step deletes an IIS object.
Part 2: Application Server Management Plugins
140 Deployment Automation
Required properties:
PropertyName
Description
Provider Type The provider type for the destination argument of the delete. Select avalue from the list below.
• Application
• Archive Directory
• ContentPath
• Directory
• File
• Manifest
• MetaKey
• Package
• Site
ProviderDestination
The provider path and setting for the destination supplied using thesyntax path,setting1,setting2….
Optional properties:
PropertyName
Description
OptionsString
A newline-separated list of arguments to concatenate onto the deletecommand. For example: –setParam:hello,value=hi\n-setParam:goodbye,value=seeyou.
CommandPath
The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.
Creating a Stop Application StepThis step stops an application in IIS.
Required properties:
Property Name Description
Target Name The name of the website or application. For example: Website/MyApp.
Plugins Guide 141
Optional properties:
PropertyName
Description
CommandPath
The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.
Creating a Recycle Application StepThis step stops an application in IIS.
Required properties:
Property Name Description
Target Name The name of the website or application. For example: Website/MyApp.
Optional properties:
PropertyName
Description
CommandPath
The directory location of the msdeploy.exe command line executable. Forexample: C:\Program Files\IIS\Microsoft Web Deploy V2\.
Part 2: Application Server Management Plugins
142 Deployment Automation
Chapter 12: Oracle WebLogic WLDeployPlugin
Oracle WebLogic Server includes the wldeploy Ant task to enable you to performweblogic.Deployer functions using attributes specified in an Ant XML file. You can usewldeploy along with other WebLogic Server Ant tasks to create a single Ant build script.
The WLDeploy plugin enables you to deploy, undeploy, and redeploy Java applications andstart and stop WebLogic servers and clusters.
In the Process Editor Available Plugin Steps, navigate to Application Server > Java> WebLogic WLDeploy.
This plugin has the following steps for you to add to your processes:
• Creating a Run WLDeploy Step [page 143]
• Creating a Start Targets Step [page 145]
• Creating a Stop Targets Step [page 146]
• Creating a Check Targets Step [page 147]
• Creating a Check Application on Targets Step [page 148]
• Creating a Wait for Application on Targets Step [page 149]
• Creating a List Applications on Targets Step [page 150]
• Creating a Create Data Source Step [page 151]
• Creating a Configure Data Source Step [page 151]
• Creating a Deploy Service Bus Configuration Step [page 152]
For information about WLDeploy, see http://docs.oracle.com/cd/E13222_01/wls/docs103//programming/wldeploy.html.
Creating a Run WLDeploy StepThis step runs a WLDeploy task.
Required properties:
PropertyName
Description
ApplicationName
The name of the application.
Plugins Guide 143
PropertyName
Description
Operation The operation for WLDeploy to execute. The options are:
• Deploy
• Undeploy
• Distribute
• Redeploy
• Start
• Stop
AdminURL
The administration URL of the WebLogic server.
Targets A comma-separated list of target servers to deploy to, for example,target1,target2.The default value is ${p:resource/wldeploy.targets}
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Optional properties:
PropertyName
Description
Source The source to deploy if doing a deployment.
Remote Check this option if deploying to a remote machine (not the machine thisagent runs on).
RetireTimeout
Specify when to retire the currently running version. Specify this only ifdoing start, redeploy, or deploy.
Plan Specify a deployment plan.
PlanVersion
Specify a deployment plan version.
Part 2: Application Server Management Plugins
144 Deployment Automation
PropertyName
Description
AlternateApplicationDescriptor
Specify an alternate application descriptor file.
AlternateWLSApplicationDescriptor
Specify an alternate WLS application descriptor file.
ApplicationVersion
Specify the application version.
Task ID Specify the ID for looking up the task.
AdditionalProps
Specify additional properties to be used as part of the WLDeploy Anttask. Use the syntax: name=value\nname=value\n
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
JMX AdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar fileif intending to use start, stop, and check status of targets.
Creating a Start Targets StepThis step starts the target server and clusters.
Required properties:
PropertyName
Description
AdminURL
The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
Plugins Guide 145
PropertyName
Description
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar file ifintending to use start, stop, and check status of targets.
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a Stop Targets StepThis step stops the target server and clusters.
Required properties:
PropertyName
Description
AdminURL
The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
Force Use the force shutdown command instead of the shutdown command.
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Part 2: Application Server Management Plugins
146 Deployment Automation
PropertyName
Description
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar file ifintending to use start, stop, and check status of targets.
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a Check Targets StepThis step checks the status of target servers and clusters.
Required properties:
PropertyName
Description
AdminURL
The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Plugins Guide 147
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar file ifintending to use start, stop, and check status of targets.
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a Check Application on Targets StepThis step checks the status of applications on target servers and clusters.
Required properties:
PropertyName
Description
ApplicationName
The application name to check the status of.
DesiredStatus
The status string to check against.
Admin URL The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
User Name The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Path toWLDeploy AntTask Jar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jarfile if intending to use start, stop, and check status of targets.
Part 2: Application Server Management Plugins
148 Deployment Automation
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a Wait for Application on Targets StepThis step waits for the status of applications on target servers and clusters to be running.
Required properties:
PropertyName
Description
ApplicationName
The application name to check the status of.
DesiredStatus
The status string to check against.
AdminURL
The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Plugins Guide 149
PropertyName
Description
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar file ifintending to use start, stop, and check status of targets.
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a List Applications on Targets StepThis step lists all application deployments for each target and sets as output properties.
Required properties:
PropertyName
Description
AdminURL
The administration URL of the WebLogic server. The default value is${p:resource/wldeploy.url}
Targets A comma-separated list of target servers to deploy to, for example,target1,target2. The default value is ${p:resource/wldeploy.targets}
UserName
The user name used to connect to WebLogic. The default value is${p:resource/wldeploy.user}
Password The password used to connect to WebLogic. The default value is${p:resource/wldeploy.password}
Optional properties:
PropertyName
Description
JMXAdminURL
The JMX administration URL of the WebLogic server. This is used whenstarting, stopping, and checking status of targets. The default value is${p:resource/wldeploy.jmxUrl}
Path toWLDeployAnt TaskJar
The path to the WebLogic WLDeploy Ant Task Jar file or full client Jar file ifintending to use start, stop, and check status of targets.
Part 2: Application Server Management Plugins
150 Deployment Automation
PropertyName
Description
AdditionalSystemProps
Specify any additional Java system properties to be added on thecommand line. Specify properties as a line-separated list in the formatprop=value, which will add -Dprop=value onto the command line.
Creating a Create Data Source StepThis step creates a JDBC MBean object to represent the data source with the listedconfiguration options.
Required properties:
Property Name Description
Hostname Enter the hostname of the Weblogic server. The default value islocalhost.
Port Enter the port on which the Weblogic server is hosted. Thedefault value is 7001.
Username Enter the username for Admin Console access.
Password Enter the password for Admin Console access.
Path to WebLogicClient Jar
Enter the full path to the WebLogic client Jar file.
Name Enter the name of the data source being created. The defaultvalue is JDBCConnectionPool.
Creating a Configure Data Source StepThis step updates an existing data source with the specified configuration options.
Required properties:
Property Name Description
Hostname Enter the hostname of the Weblogic server. The default value islocalhost.
Port Enter the port on which the Weblogic server is hosted. Thedefault value is 7001.
Username Enter the username for Admin Console access.
Plugins Guide 151
Property Name Description
Password Enter the password for Admin Console access.
Path to WebLogicClient Jar
Enter the full path to the WebLogic client Jar file.
Name Enter the name of the data source being created. The defaultvalue is JDBCConnectionPool.
Optional properties:
PropertyName
Description
DatabaseURL
Enter the database URL used to create connections in this connectionpool. The default value is jdbc:pointbase:server://localhost:7001/example
DriverName
Enter the full package name of the JDBC driver class used to create thephysical connections between the WebLogic Server and the DatabaseManagement System for this connection pool. The default value iscom.pointbase.DataSource
InitializeSQL
Enter the SQL statement to execute or initialize a physical databaseconnection. The default value is SELECT COUNT(*) FROM InitSQL
InitialConnectionPoolCapacity
Enter the number of physical database connections to create whencreating the connection pool. The default value is 1.
MaximumConnectionPoolCapacity
Enter the maximum number of physical database connections that thisconnection pool can contain. The default value is 15.
DatabasePassword
Enter the password for the database.
Creating a Deploy Service Bus Configuration StepThis step deploys a Service Bus configuration to a designated WebLogic server.
Part 2: Application Server Management Plugins
152 Deployment Automation
Required properties:
PropertyName
Description
Hostname Enter the hostname of the Weblogic server. The default value islocalhost.
Port Enter the port on which the Weblogic server is hosted. The defaultvalue is 7001.
Username Enter the username for Admin Console access.
Password Enter the password for Admin Console access.
Path toConfigurationJar
Enter the full path to the configuration Jar file that will be deployed.For example: C:\Projects\Example.jar
Path toWebLogic ClientJar
Enter the full path to the WebLogic client Jar file.
Optional properties:
Property Name Description
Deployment Description Enter a description for the session activation.
Plugins Guide 153
Part 2: Application Server Management Plugins
154 Deployment Automation
Part 3: Build Management Plugins
This section contains the following information:
• Chapter 13: Apache Ant Plugin [page 157]
• Chapter 14: Apache Maven Plugin [page 159]
• Chapter 15: Jenkins Plugin [page 161]
• Chapter 16: MS Build Plugin [page 165]
• Chapter 17: UrbanCode AnthillPro Plugin [page 167]
Plugins Guide 155
Part 3: Build Management Plugins
156 Deployment Automation
Chapter 13: Apache Ant Plugin
Apache Ant is a Java-based build tool. It is typically used to build Java applications;however, it can also be used to build C or C++ applications. With Ant, the build processand its dependencies are described using XML.
Use the Ant plugin during deployment to automate the execution of Ant tasks defined in abuild.xml file.
In the Process Editor Available Plugin Steps, navigate to Build > Build Tools > Ant.
This plugin has the following steps for you to add to your processes:
• Creating an Execute an Ant Script Step [page 157]
For information about Ant, see http://ant.apache.org/.
Creating an Execute an Ant Script StepThis step executes an Ant script.
Required properties:
PropertyName
Description
Ant ScriptFile
The name of the Ant script file.
ANT_HOME The path to the Ant installation to execute the Ant script. By default, thestep uses the agent’s ANT_HOME environment variable. This refers tothe path up to (but not including) the bin folder.
JAVA_HOME The path to the Java installation to execute Ant. By default, the agent’sJAVA_HOME environment variable is used.
Optional properties:
PropertyName
Description
Targets The names of the targets to run in the Ant script file. If left empty, thedefault target is run.
Properties The properties passed to Ant. The properties are made available by namein the Ant script. This is supplied as a newline-separated list in the formatname=value.
Plugins Guide 157
PropertyName
Description
AntProperties
Ant-specific arguments. For example, -v is used to indicate verboseoutput. This is supplied as a newline-separated list.
JVMProperties
JVM-specific arguments. For example -Xmx=512m is used for max memory.This is supplied as a newline-separated list.
ScriptContent
The content of the Ant script. The value provided here is written to the AntScript File, and then executed.
Part 3: Build Management Plugins
158 Deployment Automation
Chapter 14: Apache Maven Plugin
Apache Maven is a software project management tool that can manage a project's build,reporting, and documentation.
The Maven plugin enables you to resolve artifacts from a Maven repository.
In the Process Editor Available Plugin Steps, navigate to Repositories > Artifact >Maven.
Note: The Maven plugin is not the same as the Maven Source Config Typeintegration. Source Config Type integrations are special integrations used whenimporting component versions into Deployment Automation. For details oncomponent Source Config Types, see the Deployment Automation User's Guide.
This plugin has the following steps for you to add to your processes:
• Maven Resolve
For information about Maven, see http://maven.apache.org/.
Plugins Guide 159
Part 3: Build Management Plugins
160 Deployment Automation
Chapter 15: Jenkins Plugin
Jenkins is an application that monitors executions of repeated jobs, such as building andtesting software projects continuously and monitoring executions of externally-run jobs.
The Jenkins plugin provides steps to submit Jenkins jobs and check build results fromDeployment Automation.
In the Process Editor Available Plugin Steps, navigate to Integration > Jenkins.
Note: The Jenkins plugin is not the same as the Jenkins Source Config Typeintegration. Source Config Type integrations are special integrations used whenimporting component versions into Deployment Automation. For details oncomponent Source Config Types, see the Deployment Automation User's Guide.
This plugin has the following steps for you to add to your processes:
• Creating a Jenkins Get Build Changes Step [page 161]
• Creating a Jenkins Get Build Status Step [page 162]
• Creating a Jenkins Submit Job Step [page 162]
For information about Jenkins, see http://jenkins-ci.org/.
Creating a Jenkins Get Build Changes StepThis step returns build changes in the result.build.changes output property.
Required properties:
PropertyName
Description
Job name Specify the job name for which build changes should be returned.
Server Url Specify the URL where Jenkins is installed. For example:http://host:8080/jenkins
Optional properties:
PropertyName
Description
Buildnumber
Specify the build number for which build changes should be returned. Ifempty, the last build will be used.
Username Specify the user name that has rights to run the job.
Plugins Guide 161
PropertyName
Description
Password Specify the password.
Creating a Jenkins Get Build Status StepThis step returns the result of a build in the result.build.changes output property.
Required properties:
PropertyName
Description
Job name Specify the job name for which the build result should be returned.
Server Url Specify the URL where Jenkins is installed. For example:http://host:8080/jenkins
Optional properties:
PropertyName
Description
Buildnumber
Specify the build number for which the result should be returned. Ifempty, the last build will be used.
Username Specify the user name that has rights to run the job.
Password Specify the password.
Creating a Jenkins Submit Job StepThis step submits a Jenkins job using the parameters provided. This job can run insynchronous (waiting for job result) or asynchronous mode.
Required properties:
PropertyName
Description
Job name Specify the name of the job to run.
Server Url Specify the URL where Jenkins is installed. For example:http://host:8080/jenkins
Part 3: Build Management Plugins
162 Deployment Automation
Optional properties:
PropertyName
Description
Parameters Specify a new-line-separated list of job parameters in the followingformat:
name=value
FileParameters
Specify a new-line-separated list of files to use as job parameters. Usethe following format:
parameterName=C:/filePath.txt
Username Specify the user name that has rights to run the job.
Password Specify the password.
Wait forresult
Select if the step should wait for the job results. Default value: Selected
Waitingtimeout
Specify the time in seconds that the step will wait for a job completionmessage before failing. Empty or negative values mean infinite waiting.
Plugins Guide 163
Part 3: Build Management Plugins
164 Deployment Automation
Chapter 16: MS Build Plugin
Microsoft Build Engine (MSBuild) automates the process of compiling source code,packaging, testing, deploying, and creating documentation. Typically MSBuild is used inconjunction with Microsoft Visual Studio.
In the Process Editor Available Plugin Steps, navigate to Build > Build Tools >MSBuild.
This plugin has the following steps for you to add to your processes:
• Run MSBuild
For information about MSBuild, see http://msdn.microsoft.com/en-us/library/ms171452(v=vs.90).aspx.
Plugins Guide 165
Part 3: Build Management Plugins
166 Deployment Automation
Chapter 17: UrbanCode AnthillPro Plugin
UrbanCode AnthillPro is a continuous integration server that automates the process ofbuilding and testing code in software projects.
In the Process Editor Available Plugin Steps, navigate to Build Systems >AnthillPro.
This plugin has the following steps for you to add to your processes:
• Run Workflow
• Download Artifacts
• Assign Status
For information about AnthillPro, see http://www.urbancode.com/html/products/anthillpro/.
Plugins Guide 167
Part 3: Build Management Plugins
168 Deployment Automation
Part 4: Change and Service ManagementPlugins
This section contains the following information:
• Chapter 18: Atlassian JIRA Plugin [page 171]
• Chapter 19: CollabNet TeamForge Plugin [page 177]
• Chapter 20: JFrog Artifactory Plugin [page 179]
• Chapter 21: Microsoft Sharepoint Plugin [page 181]
• Chapter 22: SBM Plugin [page 183]
• Chapter 23: ChangeMan ZMF Plugin [page 187]
• Chapter 24: Dimensions CM Plugin [page 233]
• Chapter 25: PVCS VM Plugin [page 247]
• Chapter 26: ServiceNow Plugin [page 249]
• Chapter 27: Subversion Plugin [page 257]
Plugins Guide 169
Part 4: Change and Service Management Plugins
170 Deployment Automation
Chapter 18: Atlassian JIRA Plugin
Atlassian JIRA Software is used primarily for bug tracking, issue tracking, and projectmanagement.
The Atlassian JIRA plugin enables you to create and work with JIRA issues as part of yourdeployment process.
In the Process Editor Available Plugin Steps, navigate to Issue Tracking > JiraPlugin.
This plugin has the following steps for you to add to your processes:
• Creating an Add Comments Step [page 171]
• Creating a Check Status Step [page 172]
• Creating a Create Issue Step [page 173]
• Creating a Publish Issue Report Step [page 173]
• Creating an Update Issue Step [page 174]
For information about JIRA, see http://www.atlassian.com/software/jira/overview.
Creating an Add Comments StepThis step adds comments from the current change log to matching JIRA issues.
Required properties:
PropertyName
Description
Issue IDs A comma-separated list of issue IDs to update.
Comment The template to use for adding a comment to JIRA issues.
Fail Mode Select what to do when an unknown issue ID is found. Optionsinclude:
• Warn Only
• Fail Fast
• Fail on No Updates
JIRA Base URL The JIRA server URL.
Plugins Guide 171
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the JIRA server.
Password The password to be used to connect to the JIRA server.
PasswordScript
If you want to use a property lookup for your password, leave thepassword field blank and enter it here.
Creating a Check Status StepThis step checks the status of JIRA issues.
Required properties:
PropertyName
Description
Issue IDs A comma-separated list of issue IDs to check.
Status Name The status name of issues to check.
Fail Mode Select what to do when an unknown issue ID is found. Optionsinclude:
• Warn Only
• Fail Fast
• Fail on All Failure
• Fail on Any Failure
JIRA Base URL The JIRA server URL.
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the JIRA server.
Password The password to be used to connect to the JIRA server.
PasswordScript
If you want to use a property lookup for your password, leave thepassword field blank and enter it here.
Part 4: Change and Service Management Plugins
172 Deployment Automation
Creating a Create Issue StepThis step creates a new JIRA issue.
Required properties:
PropertyName
Description
Project Key A comma-separated list of issue IDs to update.
Issue Type The name of the issue type to create.
Assignee The assignee for the new issue. An assignee of -1 will use JIRA'sautomatic assignment.
Summary The summary for this issue.
JIRA BaseURL
The JIRA server URL.
Optional properties:
PropertyName
Description
Environment The JIRA environment where this issue occurred.
IssueDescription
The description of this issue.
User Name The user name to be used to connect to the JIRA server.
Password The password to be used to connect to the JIRA server.
PasswordScript
If you want to use a property lookup for your password, leave thepassword field blank and enter it here.
Creating a Publish Issue Report StepThis step creates a report of JIRA Issues from the current changelog.
Required properties:
Property Name Description
Output File The file to output the report to.
Issue IDs A comma-separated list of issue IDs for the report.
Plugins Guide 173
Property Name Description
JIRA Base URL The JIRA server URL.
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the JIRA server.
Password The password to be used to connect to the JIRA server.
PasswordScript
If you want to use a property lookup for your password, leave thepassword field blank and enter it here.
Creating an Update Issue StepThis step updates JIRA issues.
Required properties:
PropertyName
Description
Issue IDs A comma-separated list of issue IDs to update.
Action Name The action to be performed on the issues, such as Resolve Issue orClose Issue.
JIRA BaseURL
The JIRA server URL.
Fail Mode Select what to do when an unknown issue ID is found. Optionsinclude:
• Warn Only
• Fail Fast
• Fail on No Updates
Part 4: Change and Service Management Plugins
174 Deployment Automation
Optional properties:
PropertyName
Description
Comment Enter a comment to add to the issue when it is updated. Leave the fieldblank if you do not want to add any comments.
UserName
The user name to be used to connect to the JIRA server.
Password The password to be used to connect to the JIRA server.
PasswordScript
If you want to use a property lookup for your password, leave thepassword field blank and enter the password here.
Plugins Guide 175
Part 4: Change and Service Management Plugins
176 Deployment Automation
Chapter 19: CollabNet TeamForge Plugin
CollabNet TeamForge is an integrated Web-based platform that enables teams to workcollaboratively through the various stages of the application life cycle, including thefollowing activities: plan, code, track, build and test, lab management, release, report,and collaborate.
The TeamForge plugin enables Deployment Automation to create and modify artifacts andcreate file releases.
In the Process Editor Available Plugin Steps, navigate to Repositories > Source >TeamForge.
This plugin has the following steps for you to add to your processes:
• Comment on Tracker Artifacts
• Create Tracker Artifact
• Create Release
• Upload Release Files
• Download Release Files
• Upload Document Files
For information about TeamForge, see http://www.collab.net/products/teamforge.
Plugins Guide 177
Part 4: Change and Service Management Plugins
178 Deployment Automation
Chapter 20: JFrog Artifactory Plugin
Artifactory is a universal artifact repository manager.
The Artifactory plugin enables you to download artifacts from Artifactory Maven or NuGetrepositories. This plugin can be used for this purpose only.
In the Process Editor Available Plugin Steps, navigate to Repositories > Artifact >Artifactory.
This plugin has the following steps for you to add to your processes:
• Creating a Download Artifacts Step [page 179]
For information about Artifactory, see the JFrog Artifactory website.
Creating a Download Artifacts StepThis step downloads artifacts from a Artifactory Maven or NuGet repository.
To download component versions using the Artifactory plugin, the component must haveat least one version, with or without artifacts.
For authentication to the Artifactory server, the component Artifactory Source Config TypeUsername and Password are used. See the Deployment Automation User's Guide forinformation on Source Config Types.
Required properties: None.
Optional properties: None
Plugins Guide 179
Part 4: Change and Service Management Plugins
180 Deployment Automation
Chapter 21: Microsoft Sharepoint Plugin
SharePoint is a collection of websites that provides intranet content management anddocument management facilities.
The Sharepoint plugin enables Deployment Automation to deploy Windows SharePoint(WSP) and Content Migration Package (CMP) packages.
In the Process Editor Available Plugin Steps, navigate to Middleware > ContentManagement > Sharepoint.
This plugin has the following steps for you to add to your processes:
• Export SharePoint Content
• Deploy SharePoint CMP File
• Deploy SharePoint WSP File
• Activate SharePoint Feature
• Deploy SharePoint WSP File to Sandbox
For information about Sharepoint, see http://www.microsoft.com/en-gb/business/products/sharepoint-2013.aspx.
Plugins Guide 181
Part 4: Change and Service Management Plugins
182 Deployment Automation
Chapter 22: SBM Plugin
SBM (SBM) provides a single platform to streamline processes, speed implementation,and deliver fit-to-purpose applications in a cost effective manner.
The SBM plugin provides support for sending ALF events to SBM.
In the Process Editor Available Plugin Steps, navigate to Integration > Workflow >SBM.
This plugin has the following steps for you to add to your processes:
• Creating a Send ALF Event Step [page 183]
• Creating a Send DA ALF Event Step [page 184]
For information about SBM, see the SBM product page.
Creating a Send ALF Event StepThis step creates and sends an ALF Event to the specified SBM server.
Required properties:
PropertyName
Description
SBM URL Specify the URL where the SBM server is installed. For example:http://server:8085
Eventtype
Specify the type of change that caused the event. View the available eventtypes in SBM Composer. Select the orchestration, and then underApplication Links, select an event definition. The available types appearin the Event types list.
Objecttype
Specify the object that originated the event. View the available objecttypes in SBM Composer. Select the orchestration, and then underApplication Links, select an event definition. The available types appearin the Object types list.
Sourceproduct
Specify the SBM ALF event product. View the source product in SBMComposer. Select the orchestration, and then under Application Links,select an event definition. On the General tab of the Property Editor, thesource product appears in the Product name field.
Sourceproductversion
Specify the SBM ALF event source product version. View the sourceproduct version in SBM Composer. Select the orchestration, and thenunder Application Links, select an event definition. On the General tabof the Property Editor, the source product version appears in the Versionfield.
Plugins Guide 183
Optional properties:
PropertyName
Description
Username Specify the SBM user name.
Password Specify the SBM password.
Sourceproductinstance
Specify the SBM ALF event source product instance. View the sourceproduct instance in SBM Composer. Select the orchestration, and thenunder Application Links, select an event definition. On the General tabof the Property Editor, the source product instance appears in theProduct instance field.
Extension Specify the extension part of the request.
Object ID Object type and Object ID are used to refer to the object that originatedthe event. If not specified, a new UUID will be generated.
Debuglogs
Adds debug information to logs.
Creating a Send DA ALF Event StepThis step creates and sends a Deployment Automation ALF Event to the specified SBMserver.
Required properties:
PropertyName
Description
SBM URL Specify the URL where the SBM server is installed. For example:http://server:8085
Part 4: Change and Service Management Plugins
184 Deployment Automation
PropertyName
Description
Event type Select the ALF event type (type of change that caused the event). Theoptions are:
• StatusChanged
• ProcessStarted
• ProcessFinished
• VersionDeleted
• VersionCreated
• SnapshotCreated
• SnapshotModified
• ApprovalRequired
• ManualTaskCreated
Objecttype
Select the Deployment Automation object type (type of object thatoriginated the event). The options are:
• Component
• Application
• StandaloneProcess
• Agent
• Environment
Optional properties:
PropertyName
Description
Username Specify the SBM user name.
Password Specify the SBM password.
Plugins Guide 185
PropertyName
Description
Extension Specify the data related to your request. The Deployment Automation ALFevent can contain these values:
• ApplicationID (up to 100 values)
• ComponentIDs (up to 100 values)
• VersionIDs
• ProcessID
• ComponentProcessID
• EnvironmentID
• ResourceID
• RequestID
• ComponentProcessRequestID
• SnapshotID (up to 100 values)
• RoleNames (up to 100 values)
• UserNames
• Status
Object ID Specify the Deployment Automation object ID (the ID of the application,resource, process, or other entity that caused event) if a specific value isneeded. Note that several requests can have same object ID; for example,if they were caused by the same object. If not specified, a new UUID willbe generated.
Debuglogs
Adds debug information to logs.
Part 4: Change and Service Management Plugins
186 Deployment Automation
Chapter 23: ChangeMan ZMF Plugin
ChangeMan ZMF is a configuration management tool for IBM mainframe z/OS.
The ChangeMan ZMF plugin provides support for deployment of IBM z/OS files usingChangeMan ZMF change packages.
In the Process Editor Available Plugin Steps, navigate to Integration > ALM > ZMF.
This plugin has the following steps for you to add to your processes:
• Creating a ChangeMan ZMF Approve Step [page 188]
• Creating a ChangeMan ZMF Audit Step [page 189]
• Creating a ChangeMan ZMF Backout Step [page 192]
• Creating a ChangeMan ZMF Confirm for Backout Step [page 193]
• Creating a ChangeMan ZMF Confirm for Freeze Step [page 194]
• Creating a ChangeMan ZMF Confirm for Promotion Step [page 196]
• Creating a ChangeMan ZMF Confirm for Revert Step [page 197]
• Creating a ChangeMan ZMF Delete Package Step [page 199]
• Creating a ChangeMan ZMF Delete Scheduled Deployment Step [page 200]
• Creating a ChangeMan ZMF Demote a Package Step [page 201]
• Creating a ChangeMan ZMF Demote and Delete Contents Step [page 203]
• Creating a ChangeMan ZMF Freeze a Package Step [page 204]
• Creating a ChangeMan ZMF Get App Params Step [page 205]
• Creating a ChangeMan ZMF Get App Promotion Areas Step [page 206]
• Creating a ChangeMan ZMF Get App Sites Step [page 208]
• Creating a ChangeMan ZMF Get Approvers Step [page 209]
• Creating a ChangeMan ZMF Get Install Sites Step [page 210]
• Creating a ChangeMan ZMF Get Instructions Step [page 212]
• Creating a ChangeMan ZMF Get Properties Step [page 213]
• Creating a ChangeMan ZMF Get Scheduled Deployment Step [page 214]
• Creating a ChangeMan ZMF Get User Variables Step [page 216]
• Creating a ChangeMan ZMF Hold Deployment Step [page 217]
Plugins Guide 187
• Creating a ChangeMan ZMF Promote Package Step [page 218]
• Creating a ChangeMan ZMF Query Package Step [page 220]
• Creating a ChangeMan ZMF Reject Package Step [page 226]
• Creating a ChangeMan ZMF Release Deployment Step [page 227]
• Creating a ChangeMan ZMF Revert Package Step [page 228]
• Creating a ChangeMan ZMF Undelete Package Step [page 230]
• Creating a ChangeMan ZMF Update Scheduled Deployment Step [page 231]
For information about ChangeMan ZMF, see the ChangeMan ZMF product page.
Creating a ChangeMan ZMF Approve StepThe Approve step approves a package.
The last approver will initiate the deployment, or installation, of the package intoproduction. The installation may be scheduled or set to manual. If it is set to manual, thepackage installation job is submitted as soon as the last approval is given.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Part 4: Change and Service Management Plugins
188 Deployment Automation
PropertyName
Description
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Approver Entity The ChangeMan ZMF approver entity
Other optional properties: None.
Creating a ChangeMan ZMF Audit StepThe Audit step audits a package.
The last approver will initiate the deployment or install of the package into production.The install can be scheduled or it be set to manual. If it is set to manual, the packageinstall job is submitted as soon as the last approval is given.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Plugins Guide 189
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
PropertyName
Description
PackageName
The ChangeMan ZMF change package name
ScopeAppl
Enables you to change the default list of applications that will beconsidered for relationship checking for SRC/CPY and LOD/LOD (SYNCH5and SYNCH8). For multiple scope applications use semi-colon [;] as aseparator. Other separators will be treated as single scope applications.
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Other optional properties:
PropertyName
Description
AuditAutoParms
Indicates whether to use audit auto parms
Audit Lite Indicates whether to audit within staging libraries only rather than in bothstaging and baseline libraries
Part 4: Change and Service Management Plugins
190 Deployment Automation
PropertyName
Description
PromotionGroup
The ChangeMan ZMF promotion group from which to pull the latest files.
AuditAutoResolve
Indicates whether you want audit to resolve out-of-sync conditionsinvolving copybooks and load modules automatically.
• true: report out-of-sync conditions and submit recompile and relinkjobs to resolve SYNCH2, SYNCH4, SYNCH5, SYNCH7, SYNCH8,SYNCH9, SYNCH15, and SYNCH16 conditions.
• false: only report out-of-sync conditions but do not resolve them.
AuditIncludeHistory
Indicates whether to include audit history. Valid values are true/false.
AuditFormatReport
Indicates whether to format the report by including printer controlcharacters in the output file. Valid values are true/false.
Audit PartAs Simple
Indicates whether to audit participating ZMF change packages as simplepackages. This option lets you omit cross-package dependencies from theaudit of a participating package and follow rules for simple packagesconcerning baseline libraries. Valid values are true/false.
Audit PartAsPrimary
Indicates whether to audit participating packages as primary packages.This option lets you include cross-package dependencies for all exceptpreviously-installed packages from the audit of participating packages.Valid values are true/false.
Audit PartBy Dept
Indicates whether to audit participating packages by department number.Valid values are true/false.
Audit RCUpdateRestrictTo Target
Indicates whether to restrict the audit return code update to the targetpackage. Valid values are true/false.
AuditTraceOption
Indicates whether to use the audit trace option. Valid values are true/false.
IncludeXAPheaders
Indicates whether to include XAP headers. Valid values are Yes, No, andTop.
Plugins Guide 191
PropertyName
Description
SuppressNotify
Indicates whether to suppress the batch message. Valid values are true/false.
LockPackage
Indicates whether to lock packages during audit. Valid values are true/false.
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;] as aseparator. Other separators will be treated as a single user variable.
Creating a ChangeMan ZMF Backout StepThe Backout step backs out a package.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Part 4: Change and Service Management Plugins
192 Deployment Automation
PropertyName
Description
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Reasons Reasons for this action
Other optional properties:
PropertyName
Description
SiteName
The site name to be used. For multiple site names, use a semi-colon [;] asa separator. Other separators will be treated as a single site name.
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Creating a ChangeMan ZMF Confirm for Backout StepThe Confirm For Backout step confirms that a package is ready to be backed out.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Plugins Guide 193
PropertyName
Description
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Reasons Reasons for this action
Other optional properties:
PropertyName
Description
SiteName
The site name to be used. For multiple site names, use a semi-colon [;] asa separator. Other separators will be treated as a single site name.
Creating a ChangeMan ZMF Confirm for Freeze StepThe Confirm For Freeze step confirms that a package is ready to be frozen.
Part 4: Change and Service Management Plugins
194 Deployment Automation
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Plugins Guide 195
Other optional properties:
PropertyName
Description
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;] as aseparator. Other separators will be treated as a single user variable.
Creating a ChangeMan ZMF Confirm for Promotion StepThe Confirm For Promotion step confirms that a package is ready to be promoted.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Part 4: Change and Service Management Plugins
196 Deployment Automation
Other required properties:
PropertyName
Description
PackageName
The ChangeMan ZMF change package name
PromotionSiteName
The ChangeMan ZMF change package promotion site name
PromotionLevel
The ChangeMan ZMF change package promotion or demotion level. Thesequence number of a target promotion library in the promotionhierarchy.
PromotionName
The ChangeMan ZMF change package promotion or demotion levelnickname
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Other optional properties:
PropertyName
Description
OverlayTargetComponents
Indicates whether to overlay target library members. Valid values aretrue/false.
SuppressNotify
Indicates whether to suppress the batch message. Valid values aretrue/false.
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;]as a separator. Other separators will be treated as a single uservariable.
Creating a ChangeMan ZMF Confirm for Revert StepThe Confirm For Revert step confirms that a package is ready to be reverted back todevelopment.
Plugins Guide 197
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Reasons Reasons for this action
Part 4: Change and Service Management Plugins
198 Deployment Automation
Other optional properties:
PropertyName
Description
SiteName
The site name to be used. For multiple site names, use a semi-colon [;] asa separator. Other separators will be treated as a single site name.
Creating a ChangeMan ZMF Delete Package StepThe Delete Package step marks a package for deletion.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Plugins Guide 199
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties: None
Creating a ChangeMan ZMF Delete ScheduledDeployment StepThe Delete scheduled deployment step deletes a package promotion schedule.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Part 4: Change and Service Management Plugins
200 Deployment Automation
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
Property Name Description
Type Type. The default value is 2.
Creating a ChangeMan ZMF Demote a Package StepThe Demote a package step demotes a package.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Plugins Guide 201
PropertyName
Description
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
PropertyName
Description
PackageName
The ChangeMan ZMF change package name
PromotionSiteName
The ChangeMan ZMF change package promotion site name
PromotionLevel
The ChangeMan ZMF change package promotion or demotion level. Thesequence number of a target promotion library in the promotionhierarchy.
PromotionName
The ChangeMan ZMF change package promotion or demotion levelnickname
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Other optional properties:
PropertyName
Description
OverlayTargetComponents
Indicates whether to overlay target library members. Valid values aretrue/false.
SuppressNotify
Indicates whether to suppress the batch message. Valid values aretrue/false.
Part 4: Change and Service Management Plugins
202 Deployment Automation
PropertyName
Description
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;]as a separator. Other separators will be treated as a single uservariable.
Creating a ChangeMan ZMF Demote and DeleteContents StepThe Demote and Delete Contents step demotes a package with an option of deletingthe contents of the previous promotion libraries or areas.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Plugins Guide 203
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Promotion Site Name The ChangeMan ZMF change package promotion site name
Other optional properties:
PropertyName
Description
SuppressNotify
Indicates whether to suppress the batch message. Valid values are true/false.
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;] as aseparator. Other separators will be treated as a single user variable.
Creating a ChangeMan ZMF Freeze a Package StepThe Freeze Package step freezes a package.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Part 4: Change and Service Management Plugins
204 Deployment Automation
PropertyName
Description
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
PropertyName
Description
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;] as aseparator. Other separators will be treated as a single user variable.
Creating a ChangeMan ZMF Get App Params StepThe Get app params step gets a list of application parameters.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Plugins Guide 205
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Application Name The ChangeMan ZMF application name
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get App Promotion AreasStepThe Get app Promotion Areas step gets a list of application areas.
Part 4: Change and Service Management Plugins
206 Deployment Automation
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Application Name The ChangeMan ZMF application name
Plugins Guide 207
Other optional properties:
PropertyName
Description
SiteName
The ChangeMan ZMF installation site name
PromotionName
The ChangeMan ZMF change package promotion or demotion levelnickname
PromotionLevel
The ChangeMan ZMF change package promotion or demotion level. Thesequence number of a target promotion library in the promotionhierarchy.
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get App Sites StepThe Get App Sites step gets a list of application promotion and installation sites.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Part 4: Change and Service Management Plugins
208 Deployment Automation
PropertyName
Description
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Application Name The ChangeMan ZMF application name
Other optional properties:
PropertyName
Description
Site Type The ChangeMan ZMF installation site type
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get Approvers StepThe Get approvers step gets a list of package approvers.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
Plugins Guide 209
PropertyName
Description
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get Install Sites StepThe Get Install Sites step gets a list of package installation sites.
Part 4: Change and Service Management Plugins
210 Deployment Automation
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Plugins Guide 211
Other optional properties:
PropertyName
Description
SiteName
The ChangeMan ZMF installation site name
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get Instructions StepThe Get Instructions step gets package instructions.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Part 4: Change and Service Management Plugins
212 Deployment Automation
PropertyName
Description
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get Properties StepThe Get Properties step gets package properties.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Plugins Guide 213
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get Scheduled DeploymentStepThe Get scheduled deployment step gets a package promotion schedule.
Part 4: Change and Service Management Plugins
214 Deployment Automation
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
PropertyName
Description
PackageName
The ChangeMan ZMF change package name
KeyColumnName
This field is shown only if Display Results Selection Dialog is selected.This should typically be used with the default value.
Plugins Guide 215
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Get User Variables StepThe Get user variables step gets package user variables.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Part 4: Change and Service Management Plugins
216 Deployment Automation
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating a ChangeMan ZMF Hold Deployment StepThe Hold Deployment step holds a package promotion.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Plugins Guide 217
PropertyName
Description
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
Property Name Description
Type Type. The default value is 2.
Creating a ChangeMan ZMF Promote Package StepThe Promote Package step promotes a package.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Part 4: Change and Service Management Plugins
218 Deployment Automation
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
PropertyName
Description
PackageName
The ChangeMan ZMF change package name
PromotionSiteName
The ChangeMan ZMF change package promotion site name
PromotionLevel
The ChangeMan ZMF change package promotion or demotion level. Thesequence number of a target promotion library in the promotionhierarchy.
PromotionName
The ChangeMan ZMF change package promotion or demotion levelnickname
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Plugins Guide 219
Other optional properties:
PropertyName
Description
DeploymentDate
Deployment date
DeploymentTime
Deployment time
OverlayTargetComponents
Indicates whether to overlay target library members. Valid values aretrue/false.
SuppressNotify
Indicates whether to suppress the batch message. Valid values aretrue/false.
UserVariable
User variables to be used. For multiple variables, use a semi-colon [;]as a separator. Other separators will be treated as a single uservariable.
Creating a ChangeMan ZMF Query Package StepThe Query package step queries or searches for packages.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Part 4: Change and Service Management Plugins
220 Deployment Automation
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
PropertyName
Description
PackageList
A list of package names separated by semicolons. Other separators will betreated as single package names. Wild cards are allowed.
Other optional properties:
PropertyName
Description
WorkChangeRequest
Work change request. Wild cards are allowed.
RequestorDept
Requestor department
Search ForSimple Level
Search for simple packages?
Search ForComplexLevel
Search for complex packages?
Search ForSuper Level
Search for super packages?
Plugins Guide 221
PropertyName
Description
Search ForPart Level
Search for participating packages?
Search ForPlannedPermType
Search for planned permanent packages?
Search ForPlannedTempType
Search for planned temporary packages?
Search ForUn-plannedPermType
Search for unplanned permanent packages?
Search ForUn-plannedTempType
Search for unplanned temporary packages?
Search ForApprovedStatus
Search for approved packages?
Search ForBacked OutStatus
Search for backed out packages?
Search ForBaselineStatus
Search for baselined packages?
Search ForClosedStatus
Search for closed packages?
Search ForDeletedStatus
Search for deleted packages?
Search ForDevelopmentStatus
Search for development packages?
Search ForDeliveredStatus
Search for delivered packages?
Part 4: Change and Service Management Plugins
222 Deployment Automation
PropertyName
Description
Search ForFrozenStatus
Search for frozen packages?
Search ForInstalledStatus
Search for installed packages?
Search ForOpenedStatus
Search for opened packages?
Search ForRejectedStatus
Search for rejected packages?
Search ForTempChangeCycledStatus
Search for temporary change cycled packages?
RequestorName
Requestor name
RequestorPhone
Requestor phone
ComplexSuperPackage
Complex or super package for which you want participating packagesreturned in the search results
Creator One or more creator user IDs. Multiple creator user IDs may be listed,delimited by semicolons. Wild cards are allowed.
Audit ReturnCode
Audit return code
Search FromCreated Date
Search from Created Date
Search ToCreated Date
Search to Created Date
Search FromInstalledDate
Search from Installed Date
Plugins Guide 223
PropertyName
Description
Search ToInstalledDate
Search to Installed Date
Search FromFrozen Date
Search from Frozen Date
Search ToFrozen Date
Search to Frozen Date
Search FromApprovedDate
Search from Approved Date
Search ToApprovedDate
Search to Approved Date
Search FromRejectedDate
Search from Rejected Date
Search ToRejectedDate
Search to Rejected Date
Search FromBaselinedDate
Search from Baselined Date
Search ToBaselinedDate
Search to Baselined Date
Search FromBacked OutDate
Search from Backed Out Date
Search ToBacked OutDate
Search to Backed Out Date
Search FromRevertedDate
Search from Reverted Date
Part 4: Change and Service Management Plugins
224 Deployment Automation
PropertyName
Description
Search ToRevertedDate
Search to Reverted Date
LastPromoter
Last promoter user ID
LastPromotionLevel
Last promotion level
LastPromotionName
Last promotion nickname
LastPromotionSite
Last promotion site
Search ForFreezePending
Search for packages with freeze pending
Search ForApprovalPending
Search for packages with approval pending
Search ForInstallPending
Search for packages with install pending
Search ForRevertPending
Search for packages with revert pending
Search ForBackoutPending
Search for packages with backout pending
Search ForPostApprovalPending
Search for packages with post approval pending
Search ForPostRejected
Search for packages rejected in post approval
Plugins Guide 225
PropertyName
Description
Site Name Site name
Package Title Package title
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayedin a dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a ChangeMan ZMF Reject Package StepThe Reject Package step rejects a package.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Part 4: Change and Service Management Plugins
226 Deployment Automation
PropertyName
Description
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Approver Entity The ChangeMan ZMF approver entity
Reasons Reasons for this action
Other optional properties: None
Creating a ChangeMan ZMF Release Deployment StepThe Release Deployment step releases a previously held package promotion.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Plugins Guide 227
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties:
Property Name Description
Type Type. The default value is 2.
Creating a ChangeMan ZMF Revert Package StepThe Revert Package step reverts a package back to development.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
Part 4: Change and Service Management Plugins
228 Deployment Automation
PropertyName
Description
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Reasons Reasons for this action
Other optional properties:
PropertyName
Description
SiteName
The site name to be used. For multiple site names, use a semi-colon [;] asa separator. Other separators will be treated as a single site name.
jobCard The job card to be used. For multiple job cards use a semi-colon [;] as aseparator. Other separators will be treated as a single job card.
Plugins Guide 229
Creating a ChangeMan ZMF Undelete Package StepThe Undelete Package step undeletes a package that has been marked for deletion.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Other optional properties: None
Part 4: Change and Service Management Plugins
230 Deployment Automation
Creating a ChangeMan ZMF Update ScheduledDeployment StepThe Update scheduled deployment step updates a package promotion schedule.
Required connection properties:
PropertyName
Description
HostAddress
The TCP/IP host name or number of the LPAR of the ZMF subsystem towhich you want to connect
Port Id The TCP/IP port ID for the ChangeMan ZMF subsystem to which youwant to connect
User Id A TSO user ID or SERNET/ZMF trusted user ID that can login on behalfof other users
Password A TSO password or SERNET/ ChangeMan ZMF password
Optional connection properties:
PropertyName
Description
Login AsUser Id
The user ID that will be used to login to ChangeMan ZMF by the trusteduser ID
Login AsCurrent DAUser
Use the currently logged in Deployment Automation user ID to login toChangeMan ZMF, even if a user ID is specified in the Login As User Idfield
Web ServiceTimeoutInterval
Timeout interval in minutes for the ChangeMan ZMF web service call.The default value is 5.
Note: You should set this to a higher value if your requeststime out. Use this in conjunction with filters to limit theamount of data returned.
Other required properties:
Property Name Description
Package Name The ChangeMan ZMF change package name
Deployment Date Deployment date in yyyy/mm/dd hh:mm:ss format
Plugins Guide 231
Other optional properties:
Property Name Description
Web ServiceTimeout Interval
Timeout interval in minutes for the ChangeMan ZMF web servicecall. The default value is 5.
Part 4: Change and Service Management Plugins
232 Deployment Automation
Chapter 24: Dimensions CM Plugin
Dimensions CM is a configuration management tool.
The Dimensions CM plugin provides support for deployment of Windows and UNIX/Linuxfiles using Dimensions CM baselines.
In the Process Editor Available Plugin Steps, navigate to Integration > ALM >Dimensions CM.
This plugin has the following steps for you to add to your processes:
• Creating a Dimensions CM Action Baseline Step [page 233]
• Creating a Dimensions CM Create Baseline Step [page 234]
• Creating a Dimensions CM Deliver to a Stream Step [page 235]
• Creating a Dimensions CM Demote Baseline Step [page 236]
• Creating a Dimensions CM Deploy Baseline Step [page 237]
• Creating a Dimensions CM Get Baselines Step [page 239]
• Creating a Dimensions CM Get Deployment Areas Step [page 239]
• Creating a Dimensions CM Get Products Step [page 240]
• Creating a Dimensions CM Get Projects and Streams Step [page 241]
• Creating a Dimensions CM Get Stages Step [page 242]
• Creating a Dimensions CM Promote Baseline Step [page 242]
• Creating a Dimensions CM Rollback Area Version Step [page 244]
• Creating a Dimensions CM Upload Local File or Directory Step [page 244]
For information about Dimensions CM, see the Dimensions CM product page.
Creating a Dimensions CM Action Baseline StepThis step performs an action on the lifecycle of a baseline on the Dimensions CM server.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Plugins Guide 233
Property Name Description
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
Property Name Description
Baseline name Name of the baseline on which to perform the lifecycle action
Optional properties:
PropertyName
Description
Targetstate
Name of the state to which the object baseline should be actioned. If noneis specified, the baseline is actioned to the next state.
Comment A descriptive statement about the lifecycle action being performed.
Creating a Dimensions CM Create Baseline StepThis step creates the baseline for the specified stage.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Part 4: Change and Service Management Plugins
234 Deployment Automation
Other required properties:
PropertyName
Description
ProductName
The name of the product in Dimensions CM
Baselinename
The name of the baseline in Dimensions CM
Based on Name of the project or stream the created baseline should be based on
Baselinetype
The stage to which the baselines should be moved, or demoted. If thevalue is empty, the baseline will be demoted to the previous stage.
Optional properties:
PropertyName
Description
Attributes A new-line separated list of names and values of the attributes to set,using the syntax name=value. For example, SBM_ID=123
Creating a Dimensions CM Deliver to a Stream StepThis step delivers content to the Dimensions CM stream.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Plugins Guide 235
Other required properties:
PropertyName
Description
Productname
The name of the product in Dimensions CM
Streamname
The name of the stream to which the content should be delivered
Directory Specify the full path to the work area folder or sub-folder from which todeliver to the stream.
Optional properties:
PropertyName
Description
Add Allow the delivery to a stream the changed content in your work area andnew content previously unscheduled for delivery.
Default: False
Update Specify this qualifier to allow updating and refactoring of existing contentin the repository.
Default: True
Delete Allow the deletion from a stream the changed content in your work areaand deleted content previously unscheduled for deletion. Default: False
Attributes A new-line separated list of names and values of the attributes to set,using the syntax name=value. For example, SBM_ID=123
Comment Use the specified comment when creating new item revisions. If nocomment is specified, a default will be used.
Creating a Dimensions CM Demote Baseline StepThis step demotes the baseline to the specified stage.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Part 4: Change and Service Management Plugins
236 Deployment Automation
Property Name Description
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
Property Name Description
Product Name The name of the product in Dimensions CM
Baseline name The name of the baseline in Dimensions CM
Optional properties:
PropertyName
Description
Projectname
The name of the project in Dimensions CM
Targetstage
The stage to which the baselines should be moved, or demoted. If thevalue is empty, the baseline will be demoted to the previous stage.
Deploy Select this field if you want automatic deployment to be performed withthe demotion. Default value: True (Selected)
Areanames
The list of areas to which the baseline should be deployed. Specify multipleareas as a new-line separated list. If the ALL value is specified,deployment will be performed on all the areas. Default value: ALL
Reason Comment that describes the reason for the demotion
Wait Wait until Dimensions CM finishes processing in batch mode for this stepand returns the result, or times out, before continuing with the nextprocess step.
Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours. The default value is -1.
Creating a Dimensions CM Deploy Baseline StepThis step deploys a baseline to a specified list of areas.
Plugins Guide 237
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
PropertyName
Description
ProductName
The name of the product in Dimensions CM
Projectname
The name of the project in Dimensions CM
Baselinename
The name of the baseline in Dimensions CM
Areanames
The list of areas to which the baseline should be deployed. Specify multipleareas as a new-line separated list. If the ALL value is specified,deployment will be performed on all the areas. Default value: ALL
Optional properties:
PropertyName
Description
Reason Comment that describes the reason for the deployment
Wait Wait until Dimensions CM finishes processing in batch mode for this stepand returns the result, or times out, before continuing with the nextprocess step.
Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours. The default value is -1.
Part 4: Change and Service Management Plugins
238 Deployment Automation
Creating a Dimensions CM Get Baselines StepThis step returns a list of all the existing baselines for the specified product on theDimensions CM server.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
Property Name Description
Product Name The name of the product in Dimensions CM
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Dimensions CM Get Deployment Areas StepThis step returns a list of deployment areas on the Dimensions CM server, optionallyfiltered by stage, project, or stream.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Plugins Guide 239
Property Name Description
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties: None
Optional properties:
PropertyName
Description
Stage name Name of the stage by which you want to filter deployment areas. If thisfield is empty, areas for all stages are returned.
Stream/Project
Name of the stream or project by which you want to filter deploymentareas. If this field is empty, areas for all streams and projects arereturned.
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Dimensions CM Get Products StepThis step returns a list of all the existing products on the Dimensions CM server.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Part 4: Change and Service Management Plugins
240 Deployment Automation
Other required properties: None
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Dimensions CM Get Projects and StreamsStepThis step returns a list of all the existing projects and streams for the specified product onthe Dimensions CM server.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
Property Name Description
Product name The name of the product in Dimensions CM
Object type Object type to get. Possible values are:
• All (default)
• Projects
• Streams
Plugins Guide 241
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Dimensions CM Get Stages StepThis step returns a list of all the existing stages for the specified Dimensions CM server.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties: None
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Dimensions CM Promote Baseline StepThis step promotes the baseline to the specified stage.
Part 4: Change and Service Management Plugins
242 Deployment Automation
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
Property Name Description
Product Name The name of the product in Dimensions CM
Baseline name The name of the baseline in Dimensions CM
Optional properties:
PropertyName
Description
Projectname
The name of the project in Dimensions CM
Targetstage
The stage to which the baselines should be moved, or promoted. If thevalue is empty, the baseline will be promoted to the previous stage.
Deploy Select this field if you want automatic deployment to be performed withthe promotion. Default value: Selected
Areanames
The list of areas to which the baseline should be deployed. Specify multipleareas as a new-line separated list. If the ALL value is specified,deployment will be performed on all the areas. Default value: ALL
Reason Comment that describes the reason for the promotion
Wait Wait until Dimensions CM finishes processing in batch mode for this stepand returns the result, or times out, before continuing with the nextprocess step.
Plugins Guide 243
PropertyName
Description
Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours. The default value is -1.
Creating a Dimensions CM Rollback Area Version StepThis step rolls back the area version for the specified area.
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
PropertyName
Description
Areaname
The name of the area in Dimensions CM
Areaversion
The version of the area that should be rolled back. If no version isspecified, the latest version will be rolled back.
Optional properties:
Property Name Description
Reason Comment that describes the reason for the rollback
Creating a Dimensions CM Upload Local File orDirectory StepThe Upload Local File or Directory step delivers content to the Dimensions CM project.
Part 4: Change and Service Management Plugins
244 Deployment Automation
Required connection properties:
Property Name Description
User ID ID of the Dimensions CM user
Password Password of the Dimensions CM user
Server Host name or IP address of the Dimensions CM server
DB Name DB name for the Dimensions CM server
DB Connection DB connection for the Dimensions CM server
Other required properties:
PropertyName
Description
Product The name of the product in Dimensions CM
Projectname
The name of the project to which the files should be uploaded
Directory Specify the full path to the work area folder or sub-folder from which toupload to the project.
Optional properties:
PropertyName
Description
Attributes A new-line separated list of names and values of the attributes to setusing the syntax name=value. For example, SBM_ID=123
Description The description to apply to all the newly-created items
Comment The comment to apply to all the newly-created item revisions
Plugins Guide 245
Part 4: Change and Service Management Plugins
246 Deployment Automation
Chapter 25: PVCS VM Plugin
PVCS Version Manager (PVCS VM) is a source revision control tool.
The PVCS VM plugin provides support for checking out from PVCS.
In the Process Editor Available Plugin Steps, navigate to Repositories > Source >PVCS checkout.
This plugin has the following steps for you to add to your processes:
• Creating a PVCS Export Step [page 247]
For information about PVCS, see the PVCS product page.
Creating a PVCS Export StepThis step performs a PVCS checkout.
Required properties:
Property Name Description
PCLI Path The path to the PCLI executable.
Database Path The path to the PVCS database.
Base Path The base path of checked-out files.
Project Path The path to the PVCS project (folder) relative to the database.
Plugins Guide 247
Optional properties:
Property Name Description
Branch The branch from which to pull the latest files.
Label The label from which to pull the latest files.
Promotion Group The promotion group from which to pull the latest files.
Value for CleanWorkspace
If selected, all files are erased from the workspace before anexport is performed.
User The authentication user.
Password The user's password.
Important: You must supply a Branch, Label, or Promotion Group propertyvalue, but only one of these properties should be used.
Part 4: Change and Service Management Plugins
248 Deployment Automation
Chapter 26: ServiceNow Plugin
ServiceNow provides cloud-based services that automate IT operations.
The ServiceNow Change Management plugin enables Deployment Automation to checkapprovals and set the state of change requests.
In the Process Editor Available Plugin Steps, navigate to ITSM Process > ServiceNow.
This plugin has the following steps for you to add to your processes:
• Creating a Check Approval State Step [page 249]
• Creating a Check Change Request Child Task States Step [page 250]
• Creating a Check Change Request State Step [page 251]
• Creating a Delete Multiple Rows from CMDB Table Step [page 252]
• Creating a Delete Row from CMDB Table Step [page 253]
• Creating an Insert Row into CMDB Table Step [page 254]
• Creating a Set Change Request State Step [page 255]
• Creating an Update Task States Step [page 255]
For information about ServiceNow, see http://www.servicenow.com/.
Creating a Check Approval State StepThis step checks the approval state of a change request in ServiceNow.
Required properties:
Property Name Description
Server URL The URL for the ServiceNow server
State Enter the state to check for as an integer that matches theServiceNow state.
Change RequestNumber
The change request number for which to check the state
Plugins Guide 249
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
PasswordScript
If you want to use a script or property lookup for your password,leave the Password field blank and enter the script or lookup here.
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
HTTP ProxyPasswordScript
The password script to authenticate with the HTTP proxy
Creating a Check Change Request Child Task StatesStepThis step checks the state of all child tasks of a change request in ServiceNow.
Required properties:
Property Name Description
Server URL The URL for the ServiceNow server
State Enter the state to check for as an integer that matches theServiceNow state.
Change RequestNumber
The change request number for which to check the state
Part 4: Change and Service Management Plugins
250 Deployment Automation
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
PasswordScript
If you want to use a script or property lookup for your password,leave the Password field blank and enter the script or lookup here.
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
HTTP ProxyPasswordScript
The password script to authenticate with the HTTP proxy
Creating a Check Change Request State StepThis step checks the state of a change request in ServiceNow.
Required properties:
Property Name Description
Server URL The URL for the ServiceNow server
State Enter the state to check for as an integer that matches theServiceNow state.
Change RequestNumber
The change request number for which to check the state
Plugins Guide 251
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
PasswordScript
If you want to use a script or property lookup for your password,leave the Password field blank and enter the script or lookup here.
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
HTTP ProxyPasswordScript
The password script to authenticate with the HTTP proxy
Creating a Delete Multiple Rows from CMDB Table StepConditionally deletes multiple rows from the specified table in the ServiceNow CMDB(Configuration Management Database).
Required properties:
PropertyName
Description
ServerURL
The URL for the ServiceNow server
CMDBTableName
The name of the table to update, such as cmdb_ci_appl_list
CMDBRowCondition
Enter the condition a row must match for deletion. Seehttp://wiki.servicenow.com/index.php?title=Embedded:Encoded_Query_Strings for examples.
Part 4: Change and Service Management Plugins
252 Deployment Automation
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP Proxy Port The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
Creating a Delete Row from CMDB Table StepThis step deletes a row from the specified table in the ServiceNow CMDB (ConfigurationManagement Database).
Required properties:
Property Name Description
Server URL The URL for the ServiceNow server
CMDB Table Name The name of the table to update, such as cmdb_ci_appl_list
CMDB Row ID The unique ID of the row to delete
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP Proxy Port The port number of the HTTP proxy to use to connect to ServiceNow
Plugins Guide 253
PropertyName
Description
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
Creating an Insert Row into CMDB Table StepThis step inserts a row into the specified table in the ServiceNow CMDB (ConfigurationManagement Database).
Required properties:
Property Name Description
Server URL The URL for the ServiceNow server
CMDB Table Name The name of the table to update, such as cmdb_ci_appl_list
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
Row Fields The fields to insert for this row. Each name-value pair should be on aseparate line. A colon separates the name and value. Example:
name:value
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow, suchas proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
Part 4: Change and Service Management Plugins
254 Deployment Automation
Creating a Set Change Request State StepThis step sets the state of a change request in ServiceNow.
Required properties:
PropertyName
Description
Server URL The URL for the ServiceNow server
State Enter the state you want to set on the change request as an integerthat matches the ServiceNow state.
ChangeRequestNumber
The change request number for which to set the state
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
PasswordScript
If you want to use a script or property lookup for your password,leave the Password field blank and enter the script or lookup here.
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
HTTP ProxyPasswordScript
The password script to authenticate with the HTTP proxy
Creating an Update Task States StepThis step updates the state of all tasks in the task ID list in ServiceNow.
Plugins Guide 255
Required properties:
PropertyName
Description
Server URL The URL for the ServiceNow server
State Enter the state to update as an integer that matches the ServiceNowstate.
Task ID List A comma-separated list of task IDs to be updated
Optional properties:
PropertyName
Description
User Name The user name to be used to connect to the ServiceNow server
Password The password to be used to connect to the ServiceNow server
PasswordScript
If you want to use a script or property lookup for your password,leave the Password field blank and enter the script or lookup here.
HTTP ProxyHost
The hostname of the HTTP proxy to use to connect to ServiceNow,such as proxy.domain.com
HTTP ProxyPort
The port number of the HTTP proxy to use to connect to ServiceNow
HTTP ProxyUser Name
The user name to authenticate with the HTTP proxy
HTTP ProxyPassword
The password to authenticate with the HTTP proxy
HTTP ProxyPasswordScript
The password script to authenticate with the HTTP proxy
Part 4: Change and Service Management Plugins
256 Deployment Automation
Chapter 27: Subversion Plugin
Subversion (SVN) is an open source Version Control System (VCS).
SVN (the 5.0.1 version of the Subversion plugin):
In the Process Editor Available Plugin Steps, navigate to Integration > SVN.
Subversion-export (the 4.5.1 version of the Subversion plugin):
In the Process Editor Available Plugin Steps, navigate to Repositories > Source >Subversion.
This plugin has the following steps for you to add to your processes:
• Creating a Subversion Add Step [page 258]
• Creating a Subversion Checkout Step [page 258]
• Creating a Subversion Clean Up Step [page 259]
• Creating a Subversion Commit Step [page 259]
• Creating a Subversion Create Branch or Tag Step [page 260]
• Creating a Subversion Create Repository Step [page 261]
• Creating a Subversion Delete Step [page 261]
• Creating a Subversion Export Step (5.0.1 Plugin Version) [page 262]
• Creating a Subversion Get Lock Step [page 262]
• Creating a Subversion Import Step [page 263]
• Creating a Subversion Move Step [page 264]
• Creating a Subversion Release Lock Step [page 264]
• Creating a Subversion Revert Step [page 265]
• Creating a Subversion Switch Step [page 266]
• Creating a Subversion Update Step [page 267]
• Creating a Subversion Export Step (4.5.1 Plugin Version) [page 267]
Note:
All except the last step are for the 5.0.1 version of the Subversion plugin (SVN).The last step is for the 4.5.1 version of the Subversion plugin (Subversion-export).
For information about Subversion, see http://subversion.apache.org/.
Plugins Guide 257
Creating a Subversion Add StepThis step marks unversioned files to be uploaded to the repository during the nextcommit.
Required properties:
PropertyName
Description
Directory Location of the working directory
IncludeFiles
The list of the file paths relative to the working directory that should beadded to the repository. Wildcards can be used. Specify multiple file pathsas a new-line separated list. The default value is **/*.
Note: Use paths relative to the repository root.
Optional properties:
PropertyName
Description
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Creating a Subversion Checkout StepThis step checks out files from the remote Subversion repository to the working directory.
Required properties:
PropertyName
Description
URL URL to the repository from which files will be checked out
Directory Location to which the contents of the repository URL will be checkedout
Part 4: Change and Service Management Plugins
258 Deployment Automation
PropertyName
Description
Depth Depth of the checkout operation:
Values:
• Fully recursive (default)
• Immediate children and folders
• Only file children
• Only this item
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
Revision Number of the Subversion revision to be used during checkout. If notspecified, the HEAD revision is used.
Creating a Subversion Clean Up StepThis step recursively cleans up the working copy, removing working copy locks andresuming unfinished operations.
Required properties:
Property Name Description
Directory Location of the working directory
Optional properties: None
Creating a Subversion Commit StepThis step uploads the latest changes from the local directory to the remote repository.
Plugins Guide 259
Required properties:
PropertyName
Description
Directory Location of the working directory
IncludeFiles
The list of the file paths relative to the working directory that should becommitted to the repository. Wildcards can be used. Specify multiple filepaths as a new-line separated list. The default value is **/*.
Note: Use paths relative to the repository root.
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Message User message related to the commit
Creating a Subversion Create Branch or Tag StepThis step creates a tag or a branch in the repository.
Required properties:
Property Name Description
Directory Location of the working directory
Path Path to the branch or tag in the repository
Part 4: Change and Service Management Plugins
260 Deployment Automation
Optional properties:
Property Name Description
User Name User name of the Subversion user
Password Password of the Subversion user
Message User message related to the branch or tag
Creating a Subversion Create Repository StepThis step creates a repository.
Required properties:
Property Name Description
Directory URL to the repository to be created
Optional properties: None
Creating a Subversion Delete StepThis step removes a file or folder from the working directory.
Required properties:
PropertyName
Description
Directory Location of the working directory
IncludeFiles
The list of the file paths relative to the working directory that should bedeleted. Wildcards can be used. Specify multiple file paths as a new-lineseparated list.
Note: Use paths relative to the repository root.
Plugins Guide 261
Optional properties:
PropertyName
Description
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Creating a Subversion Export Step (5.0.1 PluginVersion)This step is for the 5.0.1 version of the Subversion plugin. It downloads files from theremote Subversion repository to the local directory. The 4.5.1 version of the plugin hasdifferent properties for the Export step. See Creating a Subversion Export Step (4.5.1Plugin Version) [page 267].
Required properties:
PropertyName
Description
URL URL to the repository from which files will be downloaded
Directory Location to which the contents of the repository URL will bedownloaded
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
Revision Number of the Subversion revision to be used during the export. If notspecified, the HEAD revision is used.
Creating a Subversion Get Lock StepThis step acquires a lock on the files in the repository.
Part 4: Change and Service Management Plugins
262 Deployment Automation
Required properties:
PropertyName
Description
Directory Location of the working directory
IncludeFiles
The list of the file paths relative to the working directory that should belocked in the repository. Wildcards can be used. Specify multiple file pathsas a new-line separated list.
Note: Use paths relative to the repository root.
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Message User message related to the lock
Creating a Subversion Import StepThis step imports a local directory to the remote Subversion repository.
Required properties:
Property Name Description
URL URL to the repository to which the files will be imported
Directory Location of the directory with imported files
Plugins Guide 263
Optional properties:
Property Name Description
User Name User name of the Subversion user
Password Password of the Subversion user
Message User message related to the import
Creating a Subversion Move StepThis step moves a file or folder in the working directory to the new location.
Required properties:
Property Name Description
Directory Location of the working directory
Destination The new path to the file or folder withinthe repository
Include Files The list of the file paths relative to theworking directory that should be moved.Wildcards can be used. Specify multiplefile paths as a new-line separated list.
Note: Use paths relative to therepository root.
Optional properties:
PropertyName
Description
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Creating a Subversion Release Lock StepThis step releases the lock on the files in the repository.
Part 4: Change and Service Management Plugins
264 Deployment Automation
Required properties:
PropertyName
Description
Directory Location of the working directory
IncludeFiles
The list of the file paths relative to the working directory that should bereleased in the repository. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Message User message related to the lock
Creating a Subversion Revert StepThis step rolls back all the changes made in the working directory for the specified files.
Required properties:
PropertyName
Description
Directory Location of the working directory
Plugins Guide 265
PropertyName
Description
IncludeFiles
The list of the file paths relative to the working directory that should bereverted. Wildcards can be used. Specify multiple file paths as a new-lineseparated list. The default value is **/*.
Note: Use paths relative to the repository root.
Optional properties:
PropertyName
Description
ExcludeFiles
The list of the file paths relative to the working directory that should beexcluded from the selection. Wildcards can be used. Specify multiple filepaths as a new-line separated list.
Note: Use paths relative to the repository root.
Creating a Subversion Switch StepThis step switches the working directory to another path in the repository.
Required properties:
Property Name Description
Directory Location of the working directory
Optional properties:
Property Name Description
User Name User name of the Subversion user
Password Password of the Subversion user
Path Path to the branch or tag in the repository
Revision Number of the Subversion revision to be used during the update
Part 4: Change and Service Management Plugins
266 Deployment Automation
Creating a Subversion Update StepThis step downloads the latest changes from the remote Subversion repository andupdates the working directory.
Required properties:
Property Name Description
Directory Location of the working directory
Optional properties:
PropertyName
Description
UserName
User name of the Subversion user
Password Password of the Subversion user
Force Forces the merge of conflicted versions with the best-effort attempt. Ifforce strategy is not used, the files will be marked as conflicted and shouldlater be resolved manually by the user.
Default value: Unchecked
Revision Number of the Subversion revision to be used during update. If therevision is not specified, the HEAD revision is used.
Creating a Subversion Export Step (4.5.1 PluginVersion)This step is for the 4.5.1 version of the Subversion plugin. It performs a Subversioncheckout or export. The 5.0.1 version of the plugin has different properties for the Exportstep. See Creating a Subversion Export Step (5.0.1 Plugin Version) [page 262].
Required properties:
Property Name Description
Project Path The project path to export (relative to repositoryUrl).
Repository Url The base URL of the Subversion repository.
Plugins Guide 267
Optional properties:
PropertyName
Description
revisionNum Optional revision to export.
revisionDate Optional date to export.
Formats accepted:
yyyy-MM-dd HH:mm:ss z
OR
E MMM dd HH:mm:ss zzz yyyy
OR
milliseconds since UNIX Epoch
CleanWorkspace
If selected, all files are erased from the workspace before an export isperformed.
RepositoryUsername
The authentication user.
Password The user's password.
CommandPath
The location of the svn command-line executable. For example:c:\Program Files\TortoiseSVN\bin\svn.exe.
Part 4: Change and Service Management Plugins
268 Deployment Automation
Part 5: Database Management Plugins
This section contains the following information:
• Chapter 28: DBDeploy Plugin [page 271]
• Chapter 29: DBUpgrader Plugin [page 273]
• Chapter 30: SQLCMD Plugin [page 275]
• Chapter 31: SQL*Plus Plugin [page 277]
• Chapter 32: SQL-JDBC Plugin [page 279]
Plugins Guide 269
Part 5: Database Management Plugins
270 Deployment Automation
Chapter 28: DBDeploy Plugin
The DBDeploy plugin enables Deployment Automation to upgrade a database.
In the Process Editor Available Plugin Steps, navigate to Database > DBDeploy.
This plugin has the following steps for you to add to your processes:
• Creating a Run DbDeploy Step [page 271]
For information about DBDeploy, see http://dbdeploy.com/.
Creating a Run DbDeploy StepYou may use this step to upgrade your database.
To create a Run DbDeploy step:
1. Enter a Name for your Run DbDeploy step.
2. Specify values for the following required properties:
Property Description
DriverClassname
Class name of the driver for the database.
DB DriverJar BasePath
Location of the DB driver jar files.
DB DriverJars
Name of the database driver .jar file. Supports the * wildcard.
URL Database URL. For example, jdbc:hsqldb:hsql://localhost/xdb
User Username for the database login.
Password Password for the username for the database login.
SQL Filepath
The path to the directory within which the SQL files reside.
Changelogtablename
Name of the change log table to use. This is useful if the DDL andDML need to be separate when deploying to replicatedenvironments.
Plugins Guide 271
Property Description
SQLstatementdelimiter
The delimiter to use to separate scripts into statements. Default is asemicolon ";"
SQLstatementdelimetertype
To split on the delimiter whenever it occurs, specify normal. To spliton the delimiter only if it is featured on a line by itself, specify row.Default is normal.
LineEnding
How lines should be separated in SQL statements that are issued byway of JDBC. By default, the step uses the appropriate line endingfor the platform it is running on and this is normally satisfactory.However, due to a bug in some Oracle drivers, the Windows defaultof CRLF may not always work.
This property takes the values:
• platform
• cr
• lf
• crlf
3. (Optional) You may choose to specify the following:
a. The Output File property can be used to switch to output script mode. Thename of the script that DBDeploy will output. This should include a full or relativepath.
b. The DB Type is required if script mode is used. This refers to the target DBMS.
c. The Template Directory is the directory from which to read customizedtemplate scripts. This is only relevant in script mode.
Part 5: Database Management Plugins
272 Deployment Automation
Chapter 29: DBUpgrader Plugin
The DBUpgrader plugin helps manage database changes, including schema changes androllbacks.
DBUpgrader uses a proprietary XML format in conjunction with a version table in yourdatabase. The XML file is used to associate changes with versions and the database tabletracks the changes that are applied. The plugin logic is used when performing upgradesfor AnthillPro and Deployment Automation applications.
In the Process Editor Available Plugin Steps, navigate to Database > DBUpgrader.
This plugin has the following steps for you to add to your processes:
• Upgrade DB
• Rollback DB
Plugins Guide 273
Part 5: Database Management Plugins
274 Deployment Automation
Chapter 30: SQLCMD Plugin
The Microsoft SQL Server SQLCMD utility is a command line application that exposes themanagement features of SQL Server. It comes with Microsoft SQL Server.
In the Process Editor Available Plugin Steps, navigate to Database > SQLCmd.
This plugin has the following steps for you to add to your processes:
• Creating a Run SQLCMD Scripts Step [page 275]
For information about the SQLCMD utility, see http://msdn.microsoft.com/en-us/library/ms162773.aspx.
Creating a Run SQLCMD Scripts StepThis step runs sqlcmd scripts in sorted order.
Required properties: None.
Note: Although none of the fields are enforced as required, you must enter asmany fields as are required to run the scripts in your environment.
Optional properties:
PropertyName
Description
Directory Offset Enter the directory offset relative to the current working directorywhere the step should run.
SQLCmdExecutable Path
Enter the full path to the sqlcmd executable if it is not on the path.
Server\Instance Enter the server or instance to connect to.
Username Enter the username for the scripts to be run as.
Password Enter the password of the user for the scripts to be run as.
Password Script Use this instead of the Password field if the password is stored in aproperty.
Use TrustedConnection
Select this to use a trusted connection instead of user/password.
Use DedicatedAdminConnection
Select this to use a dedicated administrative connection.
Plugins Guide 275
PropertyName
Description
DB Name Enter the name of the database to use.
SQL FileIncludes
Enter a new-line-separated list of file filters to determine the SQLscripts to be executed. Use this when order between files isunimportant.
Exclude Files Enter a new-line-separated list of file filters to determine the files tobe excluded from the above selection. Use in conjunction withincludes. If you are using a list in the SQL Files field, this field isignored.
SQL Files Enter a new-line-separated list of files to be executed. Use thiswhen order between files is important.
Login Timeout Enter the number of seconds before a sqlcmd login to the OLEdatabase provider times out when you try to connect to a server.The default is 8 seconds.
Part 5: Database Management Plugins
276 Deployment Automation
Chapter 31: SQL*Plus Plugin
SQL*Plus provides access to the Oracle database using the command line to enter SQL,PL/SQL, SQL *Plus and operating system commands.
The SQL*Plus plugin enables Deployment Automation to execute SQL scripts during adeployment.
In the Process Editor Available Plugin Steps, navigate to Database > SQLPlus.
This plugin has the following steps for you to add to your processes:
• Creating a Run SQLPlus Script Step [page 277]
For information about SQL*Plus, see http://docs.oracle.com/cd/B19306_01/server.102/b14357/toc.htm.
Creating a Run SQLPlus Script StepThis step runs a SQLPlus script.
Note: It is recommended that you use this step when you are running an SQLscript to create an Oracle function.
Required properties:
PropertyName
Description
SQLPlusExecutable
The full path to the sqlplus executable, the scripts to be run, or thecommand to be run, if it is on the path.
Username The username used to run the scripts.
Password The password of the user.
ConnectionID
The connection ID to be used. For example: localhost:1521/ORCL.
SQL Files A newline-separated list of SQL files to be executed. Order is preserved.Supports ‘*’ and ‘?’ as wildcards.
Optional properties:
Property Name Description
Oracle Home The ORACLE_HOME environment variable value.
Plugins Guide 277
Part 5: Database Management Plugins
278 Deployment Automation
Chapter 32: SQL-JDBC Plugin
The SQL-JDBC plugin is database-independent. It allows users to execute SQL scripts in aspecific order using JDBC drivers.
SQL-JDBC:
In the Process Editor Available Plugin Steps, navigate to Database > SQL JDBC.
SQL-JDBC-Interactive:
In the Process Editor Available Plugin Steps, navigate to Database > SQL JDBCInteractive.
This plugin has the following steps for you to add to your processes:
• Creating an Execute SQL Scripts Step [page 279]
Creating an Execute SQL Scripts StepThis step executes SQL scripts using a JDBC driver.
Required properties:
PropertyName
Description
Database JDBCDriver Name
The fully-qualified JDBC driver classname.
Driver Jar The full path to the JDBC driver jar to use.
ConnectionString
The connection string to be used. used to connect to the database.For example: jdbc:mysql://dbhost:3306/mydb.
Username The user name used to connect to the database.
SQL StatementDelimiter
String that separates SQL statements.
Error Handling Action to perform when a statement fails: continue, stop, or abort.
Column Name Column name to show values. (SQL-JDBC-Interactive Only)
Plugins Guide 279
Optional properties:
PropertyName
Description
Password The password of the user name used to connect to the database.
PasswordScript
If you wish to use a script or property lookups for your password, leavethe Password field blank and enter it here.
Files A white-space or comma separated list of sqlfiles to run. These will runin order as opposed to files grabbed using Include Files. This also takesprecedence meaning if this is set Include File box will be ignored.
IncludeFiles
Enter a new line separated set of file filters for the sql scripts toexecute. Default-value="**/*.sql"
ExcludeFiles
Enter a new line separated set of file filters for the files to exclude fromthe execution.
Autocommit Auto commit flag for database connection
Print ResultSets
Print result sets from the statements.
Part 5: Database Management Plugins
280 Deployment Automation
Part 6: Deployment and Release AutomationPlugins
This section contains the following information:
• Chapter 33: BMC ARA Plugin [page 283]
• Chapter 34: Nolio Plugin [page 285]
• Chapter 35: DA Agent Properties Collector Plugin [page 293]
• Chapter 36: DA Application Plugin [page 295]
• Chapter 37: DA Component Plugin [page 301]
• Chapter 38: DA Configuration Management Plugin [page 305]
• Chapter 39: DA Environment Plugin [page 307]
• Chapter 40: DA Resource Plugin [page 315]
• Chapter 41: Deployment Automation System Plugin [page 317]
• Chapter 42: DA Version Plugin [page 319]
• Chapter 43: DA VFS Plugin [page 321]
Plugins Guide 281
Part 6: Deployment and Release Automation Plugins
282 Deployment Automation
Chapter 33: BMC ARA Plugin
BMC Application Release Automation (ARA) enables consistent, auditable deploymentprocesses for multi-tier applications and their supporting infrastructure across physicaland virtual platforms.
In the Process Editor Available Plugin Steps, navigate to Infrastructure > ServerConfiguration > BMC ARA.
This plugin has the following steps for you to add to your processes:
• Snapshot Server
• Preview
• Install
• Generic Rundeliver
For information about BMC ARA, see http://www.bmc.com/products/product-listing/bmc-bladelogic-application-release-automation.html.
Plugins Guide 283
Part 6: Deployment and Release Automation Plugins
284 Deployment Automation
Chapter 34: Nolio Plugin
The Nolio plugin enables you to get information on the primary Nolio entities and scheduleand run processes defined in Nolio.
In the Process Editor Available Plugin Steps, navigate to Integration > CA > Nolio.
This plugin has the following steps for you to add to your processes:
• Creating a Nolio Get Agents Step [page 285]
• Creating a Nolio Get Applications Step [page 286]
• Creating a Nolio Get Environments Step [page 286]
• Creating a Nolio Get Process Tags Step [page 287]
• Creating a Nolio Get Processes Step [page 288]
• Creating a Nolio Get Server Types Step [page 289]
• Creating a Nolio Run Process Step [page 290]
• Creating a Nolio Schedule Process Run Step [page 290]
For information about CA Nolio, see http://www.ca.com/us/products/detail/ca-lisa-release-automation.aspx.
Creating a Nolio Get Agents StepThe Get Agents step returns a list of all agents on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Plugins Guide 285
Other required properties: None
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Nolio Get Applications StepThe Get Applications step returns a list of all the existing applications on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties: None
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Nolio Get Environments StepThe Get Environments step returns a list of all environments linked to the specifiedapplication on the Nolio server.
Required connection properties:
Part 6: Deployment and Release Automation Plugins
286 Deployment Automation
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
Property Name Description
Application The Nolio application name to which the Nolio environment is linked
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Nolio Get Process Tags StepThe Get Process Tags step returns a list of tag names associated with the specifiedprocess on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
Property Name Description
Application The Nolio application name to which the Nolio environment is linked
Plugins Guide 287
Property Name Description
Environment The Nolio environment name to which the Nolio process is linked
Process The full name of the Nolio process
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Nolio Get Processes StepThe Get Processes step returns a list of full process names linked to the specifiedenvironment on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
Property Name Description
Application The Nolio application name to which the Nolio environment is linked
Environment The Nolio environment name to which the Nolio process is linked
Part 6: Deployment and Release Automation Plugins
288 Deployment Automation
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Creating a Nolio Get Server Types StepThe Get Server Types step returns a list of server types associated with the specifiedenvironment on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
Property Name Description
Application The Nolio application name to which the Nolio environment is linked
Environment The Nolio environment name to which the Nolio process is linked
Process The full name of the Nolio process
Optional properties:
PropertyName
Description
UserInterventionRequired
Controls whether the information returned from this step is displayed ina dialog box upon successful execution of the containing process,enabling you to select specific information to be used in subsequentprocess steps. This is set to true by default, and is implicitly required,because without it, there is no way to select the information.
Plugins Guide 289
Creating a Nolio Run Process StepThe Run Process step runs a process on the Nolio server.
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
PropertyName
Description
Application The Nolio application name to which the Nolio environment is linked
Environment The Nolio environment name to which the Nolio process is linked
Process The full name of the Nolio process
Process Tag The name of the Nolio process tag that should be used
Servers A new-line separated list of the server types and agents in the formatof <server type>=<agent-name>
Optional properties:
PropertyName
Description
Parameters A new-line separated list of the parameter path names and values in theformat of <parameterPathName>=<value>
Wait Tells whether the step should wait until the process is completed
Timeout Time to wait until step completion, in milliseconds. A value of -1 meansthe step will wait for 24 hours.
Creating a Nolio Schedule Process Run StepThe Schedule Process Run step runs a process on the Nolio server.
Part 6: Deployment and Release Automation Plugins
290 Deployment Automation
Required connection properties:
Property Name Description
Nolio Server URL The URL to the Nolio server in the following format: //host:port
User The user name to use to log in to the Nolio server
Password The password of the Nolio user
Other required properties:
PropertyName
Description
Application The Nolio application name to which the Nolio environment is linked
Environment The Nolio environment name to which the Nolio process is linked
Process The full name of the Nolio process
Process Tag The name of the Nolio process tag that should be used
Servers A new-line separated list of the server types and agents in the formatof <server type>=<agent-name>
Date The start date of the process execution. The format of the field isdd.mm.yyyy
Time The start time of the process execution. The format of the field isHH.mm.ss (24-hour format)
Optional properties:
PropertyName
Description
Parameters A new-line separated list of the parameter path names and values in theformat of <parameterPathName>=<value>
Plugins Guide 291
Part 6: Deployment and Release Automation Plugins
292 Deployment Automation
Chapter 35: DA Agent Properties CollectorPlugin
Deployment Automation agents are associated with environments and are the physicalconnections to host machines to which you deploy or on which you run other processes.Agents are resources and may be associated with other resources that they manage andthat represent deployment targets, such as physical machines, virtual machines,databases, and J2EE containers.
The DA Agent Properties Collector plugin enables you to retrieve the resource propertiesand environment information for an agent or resource.
In the Process Editor Available Plugin Steps, navigate to Resource Tools >AgentProperiesCollector.
This plugin has the following steps for you to add to your processes:
• Retrieve Properties: This step enables you to retrieve the resource properties froma resource.
• Retrieve Environment: This step enables you to retrieve the resource environmentfrom a resource.
For information about Deployment Automation agents, environments, and resources, seethe Deployment Automation User's Guide.
Plugins Guide 293
Part 6: Deployment and Release Automation Plugins
294 Deployment Automation
Chapter 36: DA Application Plugin
Deployment Automation applications initiate component deployments; they bring togethercomponents with their deployment targets, and orchestrate multi-componentdeployments.
The DA Application plugin enables you to create and manage Deployment Automationapplications.
In the Process Editor Available Plugin Steps, navigate to DA > Applications.
This plugin has the following steps for you to add to your processes:
• Creating a Create Application Step [page 295]
• Creating a Create Application Process Step [page 296]
• Creating an Add Component To Application Step [page 296]
• Creating a Create Application Property Step [page 296]
• Creating a Create Application Role Step [page 297]
• Creating a Run Application Process Step [page 297]
• Creating a Check if Application Exists Step [page 298]
• Creating an Add User to Role Step [page 298]
• Creating an Add Group to Role Step [page 298]
Note: Using Create Application Property, you can create an applicationproperty or update the value of an existing property.
For information about Deployment Automation applications, see the DeploymentAutomation User's Guide.
Creating a Create Application StepThis step creates a Deployment Automation application.
Required properties:
Property Name Description
Application Name The name of the new application.
Plugins Guide 295
Optional properties:
Property Name Description
ApplicationDescription
A description of the new application.
Default NotificationScheme
The notification scheme for this application (will default to noneif not specified).
Enforce CompleteSnapshots
Check this box if the application should require an explicitversion for each component.
Creating a Create Application Process StepThis step creates a Deployment Automation application process.
Required properties:
Property Name Description
JSON body JSON request body that represents the process to be created.
Creating an Add Component To Application StepThis step adds a component to a Deployment Automation application.
Required properties:
Property Name Description
Application Name The name of the application.
Component Name The name of the component.
Creating a Create Application Property StepThis step creates a property for an application.
Required properties:
Property Name Description
Application Name or ID of the application that the environment belongs to.
Property Name Name of the property to set.
Part 6: Deployment and Release Automation Plugins
296 Deployment Automation
Optional properties:
Property Name Description
Property Value Value of the property to set.
Secure? Check if the property should be secure.
Creating a Create Application Role StepThis step creates a new role for applications.
Required properties:
Property Name Description
Role Name The name of the new application role.
Creating a Run Application Process StepThis step runs an application process.
Required properties:
Property Name Description
Application Name The name of the application.
Application Process Name The name of the process to run.
Environment Name The environment on which this process will run.
Optional properties:
PropertyName
Description
SnapshotName
If you are using a snapshot, enter its name here.
OnlyChangedVersions
Check this if you want to install only changed versions.
Plugins Guide 297
PropertyName
Description
ComponentVersions
If you are not using a snapshot, enter component versions here. Eachcomponent-version pair should be on a separate line. Separate eachcomponent and version number with a colon. For example: MyComponent:2.5
ApplicationProcessRequestProperties
Properties to pass to the application process request.
Wait ForApplicationProcess ToFinish
Check this if you want this step to wait until the application processfinishes. If checked, the result of this step will be the result of theapplication process (success or failure).
Creating a Check if Application Exists StepThis step succeeds if the application exists and fails if it does not.
Required properties:
Property Name Description
Application The name of the application.
Creating an Add User to Role StepThis step adds a user to a role for an application.
Required properties:
Property Name Description
User The ID of the user.
Role The name of the role.
Application The name of the application.
Creating an Add Group to Role StepThis step adds a group to a role for an application.
Part 6: Deployment and Release Automation Plugins
298 Deployment Automation
Required properties:
Property Name Description
Group The name of the group.
Role Name The name of the role.
Application Name The name of the application.
Plugins Guide 299
Part 6: Deployment and Release Automation Plugins
300 Deployment Automation
Chapter 37: DA Component Plugin
Deployment Automation components represent deployable items along with user-definedprocesses that operate on them, usually by deploying them.
The DA Component plugin enables you to create and manage Deployment Automationcomponents.
In the Process Editor Available Plugin Steps, navigate to DA > Components.
This plugin has the following steps for you to add to your processes:
• Creating a Create Component Step [page 301]
• Creating a Create Component Property Step [page 303]
• Creating a Create Component Role Step [page 303]
• Creating an Add User To Role For Component Step [page 303]
• Creating an Add Group To Role For Component Step [page 304]
• Creating a Check If Component Exists Step [page 304]
Note: Using Create Component Property, you can create an componentproperty or update the value of an existing property.
For information about Deployment Automation components, see the DeploymentAutomation User's Guide.
Creating a Create Component StepThis step creates a new Deployment Automation component.
Required properties:
Property Name Description
Component Name The name of the new component.
Plugins Guide 301
Property Name Description
Source Config Type The source configuration plugin for this component. Values are:
• None
• AnthillPro
• ClearCaseUCM
• File System (Basic)
• File System (Versioned)
• Git
• Jenkins
• Luntbuild
• Maven
• PVCS
• Perforce
• StarTeam
• Subversion
• TFS
• TFS_SCM
• TeamCity
• TeamForge
Default Version Type The types of versions to create automatically upon import.
Optional properties:
PropertyName
Description
ComponentDescription
A description of the new component.
TemplateName
If this component uses a template, enter its name here.
TemplateVersion
If this component uses a template version, enter the version numberhere.
Part 6: Deployment and Release Automation Plugins
302 Deployment Automation
PropertyName
Description
ImportVersionsAutomatically
Check to import versions automatically.
Copy ToCodestation
If checked, artifacts will be copied from the given source to theserver's Codestation repository.
Source ConfigProperties
Insert properties to pass in for the source configuration plugin.Specify one property per line, following the format name=value.
Creating a Create Component Property StepThis step creates or sets an existing component property.
Required properties:
Property Name Description
Component Name The name of the new component.
Property Name The name of the property to set.
Optional properties:
Property Name Description
Property Value The value of the property to set.
Secure? Check if the property should be secure.
Creating a Create Component Role StepThis step creates a new component role.
Required properties:
Property Name Description
Role Name The name of the new component role.
Creating an Add User To Role For Component StepThis step adds a user to a component role for a given component.
Plugins Guide 303
Required properties:
Property Name Description
User The name of the user to be added to the role.
Role The name of the component role.
Component The name of the component.
Creating an Add Group To Role For Component StepThis step adds a group to a component role for a given component.
Required properties:
Property Name Description
Group The name of the group to be added to the role.
Role The name of the component role.
Component The name of the component.
Creating a Check If Component Exists StepThis step will succeed if the component exists and fail if it doesn't.
Required properties:
Property Name Description
Component The name of the component.
Part 6: Deployment and Release Automation Plugins
304 Deployment Automation
Chapter 38: DA Configuration ManagementPlugin
Deployment Automation configuration templates typically contain configuration data forserver configurations, but the data can be for any purpose.
The DA Configuration Management plugin enables you to download and uploadconfiguration templates to and from Deployment Automation.
In the Process Editor Available Plugin Steps, navigate to Resource Tools >Configuration Management.
This plugin has the following steps for you to add to your processes:
• Creating an Install Template Step [page 305]
For information about Deployment Automation configuration templates, see theDeployment Automation User's Guide.
Creating an Install Template StepThis step installs a configuration template from Deployment Automation.
Optional properties:
Property Name Description
File Name The name of the template file to download.
Plugins Guide 305
Part 6: Deployment and Release Automation Plugins
306 Deployment Automation
Chapter 39: DA Environment Plugin
DA environments are user-defined collections of resources that host applications.
The DA Environment plugin enables you to create and manage Deployment Automationenvironments.
In the Process Editor Available Plugin Steps, navigate to DA > Environments.
This plugin has the following steps for you to add to your processes:
• Creating a Create Environment Step [page 307]
• Creating a Create Component Mapping Step [page 308]
• Creating a Create Environment Property Step [page 308]
• Creating a Get Environment Properties Step [page 309]
• Creating a Get Component Environment Properties Step [page 310]
• Creating an Inactivate Environment Step [page 310]
• Creating a Set Component Environment Property Step [page 311]
• Creating an Add User to Role For Environment Step [page 311]
• Creating an Add Group to Role For Environment Step [page 312]
• Creating a Verify Inventory Status Step [page 312]
• Creating a Check If Environment Exists Step [page 312]
Note: Using Create Environment Property, you can create an environmentproperty or update the value of an existing property.
For information about Deployment Automation environments, see the DeploymentAutomation User's Guide.
Creating a Create Environment StepThis step creates a Deployment Automation environment for the specified application.
Required properties:
Property Name Description
Application Name The name of the application the environment will be created for.
Environment Name The name of the environment to be created.
Plugins Guide 307
Optional properties:
PropertyName
Description
AppendUniqueSuffix
Check this box if you want to guarantee your environment name isunique.
Description A description of the environment to be created.
RequireApprovals
Check this box if the environment will require approval from anapproval process to install versions or snapshots.
Creating a Create Component Mapping StepThis step creates a component mapping.
Required properties:
PropertyName
Description
ComponentName
The name of the component to be mapped.
EnvironmentName
The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Optional properties:
PropertyName
Description
ApplicationName
The name of the application the environment belongs to. This property isnot required if you specify the environment ID, but is required if youspecify the environment name.
ResourceName
The resource for which the component mapping will be created. Thisproperty is not needed if you specify the resource group.
ResourceGroup
The path to the resource group for which the component mapping will becreated. This property is not needed if you specify the resource name.For example: /Groups/MyGroup
Creating a Create Environment Property StepThis step creates a property for an application environment.
Part 6: Deployment and Release Automation Plugins
308 Deployment Automation
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
PropertyName
The name of the property to set.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
PropertyValue
The name of the property to set.
Secure? Check if the property should be secure.
Creating a Get Environment Properties StepThis step gets the name-value pairs of all environment properties and sets them as outputproperties. Secure property values cannot be resolved.
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
Plugins Guide 309
Creating a Get Component Environment PropertiesStepThis step gets the name-value pairs of all component environment properties and setsthem as output properties. Secure property values cannot be resolved.
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Component The name or ID of the component.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
Creating an Inactivate Environment StepThis step inactivates the target environment.
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
Part 6: Deployment and Release Automation Plugins
310 Deployment Automation
Creating a Set Component Environment Property StepThis step sets an environment-specific property value for a component. The property mustalready exist.
Required properties:
PropertyName
Description
Component The name or ID of the component that the environment belongs to.
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
PropertyName
The name of the property to set.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not required if you specify the environment by ID instead ofby name.
PropertyValue
The value of the property to set.
Secure? Check if the property should be secure.
Creating an Add User to Role For Environment StepThis step adds a user to a role for a given application environment.
Required properties:
Property Name Description
User The name of the user who will be added to the role.
Role The user role to which the user will be added.
Environment The name or ID of the environment.
Application The name or ID of the application that the environment belongs to.
Plugins Guide 311
Creating an Add Group to Role For Environment StepThis step adds a group to a role for a given application environment.
Required properties:
Property Name Description
Group The name of the group that will be added to the role.
Role The group role to which the group will be added.
Environment The name or ID of the environment.
Application The name or ID of the application that the environment belongs to.
Creating a Verify Inventory Status StepThis step verifies that the environment has a component with a certain version ininventory.
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Component The name or ID of the component to verify.
Version The name of the version to verify.
Status The inventory entry must match this status (case sensitive). Defaultpossible statuses are Active or Staged, but custom statuses are alsopossible.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
Creating a Check If Environment Exists StepThis step will succeed if the environment exists and fail if it does not.
Part 6: Deployment and Release Automation Plugins
312 Deployment Automation
Required properties:
PropertyName
Description
Environment The name or ID of the environment. If you specify an ID, you do notneed to specify the application.
Optional properties:
PropertyName
Description
Application The name or ID of the application that the environment belongs to. Thisproperty is not needed if you refer to the environment by ID instead ofby name.
Plugins Guide 313
Part 6: Deployment and Release Automation Plugins
314 Deployment Automation
Chapter 40: DA Resource Plugin
DA resources represent deployment targets, such as a physical machines, virtualmachines, databases, and J2EE containers.
In the Process Editor Available Plugin Steps, navigate to DA > Resources.
This plugin has the following steps for you to add to your processes:
• Create Resource
• Add Resource to Group
• Create Resource Group
• Create Dynamic Resource Group
• Add Name Condition To Group
• Add Property Condition To Group
• Set Agent Property
• Set Resource Property
• Set Resource Role Property
• Check If Resource Has Role
• Add Role To Resource
• Remove Role From Resource
• Delete Resource Group
• Delete Resource
• Delete Agent
• Delete Many Resources
• Delete Many Agents
• Get Agent Property
• Get Resource Property
• Get Resource Role Property
• Delete Resource Inventory For Component
• Check If Resource Exists
• Add User To Role For Resource
Plugins Guide 315
• Add Group To Role For Resource
• Get Component Version For Resource
• Wait For Resources
• Add User To Role For Resource Group
• Add Group To Role For Resource Group
For information about Deployment Automation resources, see the Deployment AutomationUser's Guide.
Part 6: Deployment and Release Automation Plugins
316 Deployment Automation
Chapter 41: Deployment AutomationSystem Plugin
The DA System plugin enables you to enter system, or global, properties to be used by aprocess.
In the Process Editor Available Plugin Steps, navigate to DA > System.
This plugin has the following steps for you to add to your processes:
• Creating a Deployment Automation System Property Step [page 317]
For information about Deployment Automation System Properties, see the DeploymentAutomation User's Guide.
Creating a Deployment Automation System PropertyStepYou may use this step to enter system, or global, properties to be used by a process.
To create a Deployment Automation System Property step:
1. Enter a Name for your Deployment Automation System Property step.
2. In the Property Name field, enter the name of the Deployment Automation systemproperty to be set by this step.
3. (Optional) You may choose to specify the following:
a. The Property Value to which you want the Deployment Automation systemproperty set by this step.
b. Secure the Deployment Automation system property so that it is storedencrypted and is shown as asterisks in the Deployment Automation userinterface.
Plugins Guide 317
Part 6: Deployment and Release Automation Plugins
318 Deployment Automation
Chapter 42: DA Version Plugin
Deployment Automation provides component version control using the Versioned FileStorage (VFS) repository. CodeStation is the name of the service that manages and storesartifacts in the repository.
In the Process Editor Available Plugin Steps, navigate to DA > Version.
This plugin has the following steps for you to add to your processes:
• Add Status to Version
• Remove Status From Version
• Create Version
For information about Deployment Automation component version control andCodeStation , see the Deployment Automation User's Guide.
Plugins Guide 319
Part 6: Deployment and Release Automation Plugins
320 Deployment Automation
Chapter 43: DA VFS Plugin
Deployment Automation Versioned File Storage (VFS) enables you to add artifacts to theDeployment Automation version repository, CodeStation .
The DA VFS plugin enables you to access artifacts in the Deployment Automation VFSartifact repository, CodeStation.
In the Process Editor Available Plugin Steps, navigate to Repositories > Artifact >DA.
This plugin has the following steps for you to add to your processes:
• Creating a Download Artifacts Step [page 321]
• Creating an Upload Artifacts Step [page 322]
• Creating an Upload Step Attachment Step [page 323]
• Creating a Verify Local Artifacts Step [page 324]
For more information about Deployment Automation CodeStation, see the DeploymentAutomation User's Guide.
Creating a Download Artifacts StepThis step downloads artifacts from a VFS. In the standard plugin, the VFS is CodeStation.
Required properties:
PropertyName
Description
DirectoryOffset
The working directory to be used when executing this command. This isrelative to the current working directory.
Includes The list of the files relative to the directory offset that should be includedin the selection. Wildcards can be used. The wildcard ** indicates everydirectory and the wildcard * indicates every file. For example, the patterndist/**/* would retrieve the entire file tree under the dist directory.
Plugins Guide 321
Optional properties:
PropertyName
Description
Excludes The list of the files relative to the directory offset that should be excludedfrom the selection. Wildcards can be used. The wildcard ** indicatesevery directory and the wildcard * indicates every file. For example, thepattern dist/**/* would retrieve the entire file tree under the distdirectory.
Sync Mode Select the mode as follows:
• Sync transfers only changed files, removing files that exist only in thepreviously-deployed version.
• Clean removes all files not contained in the currently deployedversion.
FullVerification
(Valid only with Sync Mode selected) When this is selected, hashes willbe computed on each file in the destination artifact set to determinewhether network transfer is necessary. Otherwise, files will be comparedby date modified and size.
Save FileExecuteBits
If this is selected, the file execute bits will be saved with the files.
Verify FileIntegrity
When this is selected, the download process verifies that the downloadedfiles match their hash. Selecting this may negatively impactperformance.
Creating an Upload Artifacts StepThis step uploads artifacts to a VFS. In the standard plugin, the VFS is CodeStation.
Required properties:
PropertyName
Description
User The name of the user making the change.
Comment A comment that describes the change.
DirectoryOffset
The working directory to be used when executing this command. This isrelative to the current working directory.
Part 6: Deployment and Release Automation Plugins
322 Deployment Automation
PropertyName
Description
Includes The list of the files relative to the directory offset that should be includedin the selection. Wildcards can be used. The wildcard ** indicates everydirectory and the wildcard * indicates every file. For example, the patterndist/**/* would retrieve the entire file tree under the dist directory.
Optional properties:
PropertyName
Description
Update If this is selected, the change set will be added to the old one rather thancreating a completely new one.
Excludes The list of the files relative to the directory offset that should be excludedfrom selection. Wildcards can be used. Specify multiple file paths as anew-line separated list.
Save FileExecuteBits
If this is selected, the file execute bits will be saved with the files.
Creating an Upload Step Attachment StepThis step uploads a designated step attachment to the Deployment Automation server.
Required properties:
PropertyName
Description
AttachmentName
Name of the file attachment to upload.
Path Path to the file attachment to upload. The default is ${p:prevStep/logPath}, which uploads the log of the previously-executed step andattaches it to this step.
TargetStep
Target step to which the attachment should be uploaded.
Plugins Guide 323
Optional properties:
PropertyName
Description
Format Format of the attachment file. Options are:
• Plain Text
• HTML
• Image
• Binary
Delete AfterUpload
If this is selected, the file attachment will be deleted after it isuploaded to the remote server.
Creating a Verify Local Artifacts StepThis step compares artifacts on a local machine with the inventory in the VFS. In thestandard plugin, the VFS is CodeStation.
Required properties:
PropertyName
Description
DirectoryOffset
The working directory to be used when executing this command. This isrelative to the current working directory.
Includes The list of the files relative to the offset directory that should be includedin the selection. Wildcards can be used. The wildcard ** indicates everydirectory and the wildcard * indicates every file. For example, the patterndist/**/* would retrieve the entire file tree under the dist directory.
Optional properties:
PropertyName
Description
Excludes The list of the files relative to the offset directory that should be excludedfrom the selection. Wildcards can be used. The wildcard ** indicates everydirectory and the wildcard * indicates every file. For example, the patterndist/**/* would retrieve the entire file tree under the dist directory.
Part 6: Deployment and Release Automation Plugins
324 Deployment Automation
Part 7: Integration Plugins
This section contains the following information:
• Chapter 44: Atlassian Bamboo Plugin [page 327]
• Chapter 45: Chef Plugin [page 333]
• Chapter 46: Docker Plugin [page 345]
• Chapter 47: Informatica Plugin [page 353]
• Chapter 48: Microsoft BizTalk Plugin [page 355]
• Chapter 49: Oracle Business Intelligence Plugin [page 357]
• Chapter 50: Puppet Plugin [page 361]
• Chapter 51: Web Services Plugin [page 369]
Plugins Guide 325
Part 7: Integration Plugins
326 Deployment Automation
Chapter 44: Atlassian Bamboo Plugin
Bamboo is a continuous integration server from Atlassian.
The Atlassian Bamboo plugin enables you to get information from the Atlassian Bambooserver and submit and manage builds.
In the Process Editor Available Plugin Steps, navigate to Integrations > AtlassianBamboo.
This plugin has the following steps for you to add to your processes:
• Creating a Get All Projects Step [page 327]
• Creating a Get All Plans Step [page 327]
• Creating a Get Queued Builds Step [page 328]
• Creating a Make Build Step [page 328]
• Creating a Get Build Comments Step [page 329]
• Creating an Add Build Comments Step [page 330]
For information about Bamboo, see https://www.atlassian.com/software/bamboo.
Creating a Get All Projects StepThis step returns all projects from the Atlassian Bamboo server.
Required properties:
Property Name Description
Server URL Specify the Atlassian Bamboo server URL.
Optional properties:
Property Name Description
Username Specify the user name.
Password Specify the password.
Debug logs Adds debug information to logs.
Creating a Get All Plans StepThis step returns all plans from the Atlassian Bamboo server.
Plugins Guide 327
Required properties:
Property Name Description
Server URL Specify the Atlassian Bamboo server URL.
Optional properties:
Property Name Description
Username Specify the user name.
Password Specify the password.
Debug logs Adds debug information to logs.
Creating a Get Queued Builds StepThis step returns all queued builds from the Atlassian Bamboo server.
Required properties:
Property Name Description
Server URL Specify the Atlassian Bamboo server URL.
Optional properties:
Property Name Description
Username Specify the user name.
Password Specify the password.
Debug logs Adds debug information to logs.
Creating a Make Build StepThis step submits a new build and waits until it is finished.
Required properties:
PropertyName
Description
ServerURL
Specify the Atlassian Bamboo server URL.
Part 7: Integration Plugins
328 Deployment Automation
PropertyName
Description
Plan Specify the Atlassian Bamboo project plan to build. You can specify it as"Project-Plan" and leave the Project field empty. The plan key (not name)is expected, so the value will be converted to uppercase.
Optional properties:
PropertyName
Description
Username Specify the user name.
Password Specify the password.
Project Specify the Atlassian Bamboo project to build. The project key (not name)is expected, so the value will be converted to uppercase.
Wait forresult
Specify if the step should wait until the build is finished. The options are:
• Don't wait
• Wait for build
Timeout Specify the time in seconds that the step will wait for a build completionmessage before failing. Empty or negative values mean infinite waiting.
Debuglogs
Adds debug information to logs.
Creating a Get Build Comments StepThis step returns build comments.
Required properties:
PropertyName
Description
ServerURL
Specify the Atlassian Bamboo server URL.
Build Specify the build number. You can specify it as "Project-Plan-Build" andleave the Project and Plan fields empty.
Plugins Guide 329
Optional properties:
PropertyName
Description
Username Specify the user name.
Password Specify the password.
Project Specify the Atlassian Bamboo project. The project key (not name) isexpected, so the value will be converted to uppercase.
Plan Specify the Atlassian Bamboo project plan. You can specify it as "Project-Plan" and leave the Project field empty. The plan key (not name) isexpected, so the value will be converted to uppercase.
Debuglogs
Adds debug information to logs.
Creating an Add Build Comments StepThis step adds new comments to an existing build.
Required properties:
PropertyName
Description
ServerURL
Specify the Atlassian Bamboo server URL.
Build Specify the build number. You can specify it as "Project-Plan-Build" andleave the Project and Plan fields empty.
Commenttext
Specify the new comment text.
Optional properties:
PropertyName
Description
Username Specify the user name.
Password Specify the password.
Project Specify the Atlassian Bamboo project. The project key (not name) isexpected, so the value will be converted to uppercase.
Part 7: Integration Plugins
330 Deployment Automation
PropertyName
Description
Plan Specify the Atlassian Bamboo project plan. You can specify it as "Project-Plan" and leave the Project field empty. The plan key (not name) isexpected, so the value will be converted to uppercase.
Debuglogs
Adds debug information to logs.
Plugins Guide 331
Part 7: Integration Plugins
332 Deployment Automation
Chapter 45: Chef Plugin
Chef helps to automate infrastructure tasks, such as configuring web servers, databases,and load balancers.
The Chef plugin enables you to execute several Chef tasks as part of your DeploymentAutomation processes.
In the Process Editor Available Plugin Steps, navigate to Integration >Configuration Management > Chef.
This plugin has the following steps for you to add to your processes:
• Creating a Chef Bootstrap *nix or Windows Node Step [page 334]
• Creating a Client Bulk Delete Step [page 335]
• Creating a Cookbook Bulk Delete Step [page 336]
• Creating a Create Cookbook Step [page 336]
• Creating a Create or Edit Role Step [page 337]
• Creating a Create Recipe Step [page 337]
• Creating a Delete Client Step [page 338]
• Creating a Delete Cookbook Step [page 338]
• Creating a Delete Node Step [page 339]
• Creating a Delete Recipe Step [page 339]
• Creating a Delete Role Step [page 339]
• Creating a Delete User Step [page 339]
• Creating a Deploy Chef Step [page 339]
• Creating a Generic Knife Command Step [page 340]
• Creating an Install Cookbook from Site Step [page 340]
• Creating a Node Bulk Delete Step [page 341]
• Creating a Role Bulk Delete Step [page 341]
• Creating a Run-list Add Step [page 341]
• Creating a Run-list Remove Step [page 342]
• Creating an Upload Step [page 342]
For information about Chef, see http://www.getchef.com/chef/.
Plugins Guide 333
Creating a Chef Bootstrap *nix or Windows Node StepThis step installs Chef on the given client and runs that node's run-list.
Required properties:
PropertyName
Description
FQDN or IPAddress
Enter the FQDN or IP address of the target computer.
Target OSType
Select the target or client node operating system type where the chef-client should be bootstrapped.
Optional properties:
PropertyName
Description
Node Name Enter the name of the node.
SSH UserName
Enter the SSH user name.
SSHPassword
Enter the SSH password. This can be used to pass the password directlyon the command line. If this option is not specified and a password isrequired, Knife will prompt for the password.
Use SSHPassword asSudoPassword
If selected and a bootstrap operation is done using Sudo, the SSHpassword will be used.
Run as Sudo If selected, the bootstrap operation will execute using Sudo.
SudoPassword
Enter a Sudo password if the Use SSH password as Sudo Password isnot selected.
SSHForwarding
If selected, SSH agent forwarding is enabled.
Proxy URL The proxy server for the target node of the bootstrap operation.
ChefVersion
Enter the version of the chef-client to install.
Part 7: Integration Plugins
334 Deployment Automation
PropertyName
Description
Distributions Enter the template file to be used during a bootstrap operation.Supported distributions are: chef-full (default), centos5-gems,fedora13-gems, ubuntu10.04-gems, ubuntu10.04-apt,ubuntu12.04-gems, and custom bootstrap template files. When thisoption is used, Knife will search for the template file in the followingorder: the bootstrap/ folder in current working directory, in the chef-repo, or in the ~/.chef/ directory; a default bootstrap file. Do not usethe Template option when this option is specified.
SSHGateway
Enter the SSH tunnel or gateway that is used to run a bootstrap actionon a machine that is not accessible from the workstation.
Hint HINT_NAME[=HINT_FILE] Enter the Ohai hint to be set on the target ofthe bootstrap. The hint is contained in a file and is formatted as JSON:{'attribute':'value','attribute':'value'...}. HINT_NAME is the name of thehint and HINT_FILE is the name of the hint file located at /etc/chef/ohai/hints/HINT_FILE.json.
Identity File Enter the SSH identity file used for authentication. Key-basedauthentication is recommended.
JSONAttributes
Enter a JSON string to add to the first run of a chef-client.
Verify HostKey
If selected, the host key is verified.
SSH Port Enter the port SSH uses.
Prerelease If selected, prerelease gems will be installed.
Run-list Enter a comma-separated list of roles and/or recipes to be added to thisnode's run-list after it is has been bootstrapped.
Secret Enter the encryption key that is used for values contained within a databag item.
Secret File Enter the path to the file that contains the encryption key.
Template Enter the path to a template file that will be used during a bootstrapoperation. Do not use the Distributions option when this is specified.
Creating a Client Bulk Delete StepThis step deletes clients from the Chef server in bulk.
Plugins Guide 335
Required properties:
Property Name Description
Regular Expression Enter a regular expression to define which clients to delete.
Optional properties: None.
Creating a Cookbook Bulk Delete StepThis step deletes cookbooks from the Chef server in bulk.
Required properties:
Property Name Description
Regular Expression Enter a regular expression to define which cookbooks to delete.
Optional properties:
PropertyName
Description
Purge If selected, completely removes cookbooks from the server. This will causeany other cookbooks that reference the deleted cookbooks to be disabled.
Creating a Create Cookbook StepThis step creates a new cookbook on the Chef server.
Required properties:
Property Name Description
Cookbook Name Enter the name of the cookbook you want to create.
Optional properties:
PropertyName
Description
CopyrightHolder
Enter the name of the copyright holder for this cookbook.
Part 7: Integration Plugins
336 Deployment Automation
PropertyName
Description
Type ofLicense
Select the type of license under which the cookbook is distributed.Values include:
Apache v2.0, GPL v2, GPL v3, MIT, and Proprietary - All RightsReserved
Owner Email Enter the email ID of the person who will maintain this cookbook.
Cookbook Path Enter the directory where the cookbook is to be created.
DocumentFormat
Select the format for the Release Notes file. Values include: .md and.rdoc
Creating a Create or Edit Role StepThis step creates a role or edits an existing role on the Chef server.
Required properties:
PropertyName
Description
JSON DataSource
Select from options to load the data source from a file or use the textbox enter your own JSON data.
Optional properties:
PropertyName
Description
Role JSONData
Enter the JSON data that will describe the new or edited role.
JSON File Path Enter the path to the JSON file, which describes the new role to becreated.
Creating a Create Recipe StepThis step creates a recipe.
Required properties:
Property Name Description
Recipe Full File Path Enter the path and name of the recipe to create.
Plugins Guide 337
Property Name Description
Recipe Contents Enter the code that will go into the recipe.
Optional properties:
Property Name Description
Overwrite If selected, overwrites the recipe if it exists.
Creating a Delete Client StepThis step deletes a single client from the Chef server.
Required properties:
Property Name Description
Client Name Enter the name of the client to be deleted.
Optional properties: None.
Creating a Delete Cookbook StepThis step deletes a single cookbook from the Chef server.
Required properties:
Property Name Description
Cookbook Name Enter the name of the cookbook to be deleted.
Optional properties:
PropertyName
Description
Version Enter the version of the cookbook to delete. You must enter the exactversion if 'Delete All' is not selected.
Delete All If selected, deletes all versions of the cookbook
Purge If selected, completely removes the cookbook from the server. This willdisable any other cookbooks that reference any files in the cookbook thatis being deleted.
Part 7: Integration Plugins
338 Deployment Automation
Creating a Delete Node StepThis step deletes a node from the Chef server.
Required properties:
Property Name Description
Node Name Enter the name of the node to be deleted.
Optional properties: None.
Creating a Delete Recipe StepThis step deletes a recipe at a given file location.
Required properties:
Property Name Description
Recipe File Path Enter the file path of the recipe to be deleted.
Optional properties: None.
Creating a Delete Role StepThis step deletes a single role from the Chef server.
Required properties:
Property Name Description
Role Name Enter the name of the role to be deleted.
Optional properties: None.
Creating a Delete User StepThis step deletes a single user from the Chef server.
Required properties:
Property Name Description
User Name Enter the name of the user to be deleted.
Optional properties: None.
Creating a Deploy Chef StepThis step deploys Chef to a node.
Plugins Guide 339
Required properties:
Property Name Description
Query or IPAddress
Enter the query or IP address for the node to which you want todeploy.
SSH Login Enter the SSH login for the nodes.
SSH Password Enter the SSH password for the login.
Optional properties:
PropertyName
Description
SudoPassword
Enter the password to allow for Sudo on the nodes. If no password isgiven, the SSH password will be used.
Creating a Generic Knife Command StepThis step enables you to execute any knife command.
Required properties:
PropertyName
Description
KnifeCommand
Enter the Knife command to run, without 'knife' at the beginning. Forexample, to execute the command 'knife client list', enter 'client list'.
Optional properties: None.
Creating an Install Cookbook from Site StepThis step enables the user to install Chef cookbooks from the cookbook community hostedat http://community.opscode.com/.
Required properties:
Property Name Description
Cookbook Name Enter the name of the cookbook to be installed.
Part 7: Integration Plugins
340 Deployment Automation
Optional properties:
Property Name Description
Cookbook Version Enter the version of the cookbook to be installed.
Use CurrentBranch
If selected, the current branch will be used.
Default BranchName
Enter the name of the default branch. The default is the masterbranch.
SkipDependencies
If selected, cookbooks to which the installed cookbook hasdependencies will not be installed.
CookbookInstallation Path
Enter the directory in which the cookbook will be created. This canbe a colon-separated path.
Creating a Node Bulk Delete StepThis step deletes nodes from the Chef server in bulk.
Required properties:
Property Name Description
Regular Expression Enter a regular expression to delete multiple nodes.
Optional properties: None.
Creating a Role Bulk Delete StepThis step deletes roles from the Chef server in bulk.
Required properties:
Property Name Description
Regular Expression Enter a regular expression to define which roles to delete.
Optional properties: None.
Creating a Run-list Add StepThis step adds to the run-list of a node by adding recipes or roles in a specific order.
Plugins Guide 341
Required properties:
PropertyName
Description
NodeName
Enter the name of the node you wish to update.
Run-listItem
Enter a comma-separated list of roles and recipes you want to add. Enterroles as 'role[ROLE_NAME]'. Enter the full recipe format as'recipe[COOKBOOK::RECIPE_NAME]'. Add recipes with a cookbook as'COOKBOOK::RECIPE_NAME'. Add the default recipe by using'COOKBOOK'.
Optional properties:
Property Name Description
After Item Enter the run-list item to add after the specified recipe or role item.
Creating a Run-list Remove StepThis step removes an item from the run-list of a node.
Required properties:
PropertyName
Description
NodeName
Enter the name of the node you wish to update.
Run-listItem
Enter a comma-separated list of roles and recipes you want to remove.Enter roles as 'role[ROLE_NAME]'. Enter the full recipe format as'recipe[COOKBOOK::RECIPE_NAME]'. Add recipes with a cookbook as'COOKBOOK::RECIPE_NAME'. Add the default recipe by using'COOKBOOK'.
Optional properties: None.
Creating an Upload StepThis step uploads a cookbook, role, environment, or data bag to the Chef server.
Part 7: Integration Plugins
342 Deployment Automation
Required properties:
PropertyName
Description
Pattern Enter a cookbook pattern to upload.
Directory Enter the directory from which to run the command. This is typicallythe chef-repo."
Optional properties:
PropertyName
Description
ConcurrentConnectionsAllowed
Enter the maximum number of concurrent connections allowed. Thedefault is 10.
Upload Newor ModifiedFiles
If selected, upload only new or modified files to the server.
UploadUnmodifiedFiles
If selected, this forces the upload of files even if they have not beenmodified.
FreezeCookbook
If selected, this version of the cookbook cannot be modified after theupload. Any changes to this cookbook must be uploaded later as anew version.
Dry Run If selected, no action is taken and only results are printed out.
Purge Non-chef-repoFiles
If selected, deletes items on the server, such as roles and cookbooks,that are NOT contained in the chef-repo.
DisableRecursiveUpload
If selected, disables the recursive uploading of the directory.
Local Chef-repo Layout
Select the layout of the local chef-repo. Values include: static,everything, and hosted_everything
Plugins Guide 343
Part 7: Integration Plugins
344 Deployment Automation
Chapter 46: Docker Plugin
Docker automates the deployment of applications inside software containers.
The Docker plugin provides tasks to interact with Docker Engine.
In the Process Editor Available Plugin Steps, navigate to Integrations >Configuration Management > Docker.
This plugin has the following steps for you to add to your processes:
• Creating a Build From Dockerfile Step [page 345]
• Creating a Commit Image Step [page 346]
• Creating an Execute Command Step [page 346]
• Creating an Export to Tar Step [page 346]
• Creating an Inspect Step [page 347]
• Creating an Import from Tar Step [page 347]
• Creating a Pull Image Step [page 347]
• Creating a Push Image Step [page 348]
• Creating a Remove Container Step [page 348]
• Creating a Restart Container Step [page 349]
• Creating a Run Command Step [page 349]
• Creating a Save Image Step [page 349]
• Creating a Start Container Step [page 350]
• Creating a Stop Container Step [page 350]
• Creating a Tag Image Step [page 351]
For information about Docker, see https://www.docker.com.
Creating a Build From Dockerfile StepThis step builds an image from a specified Dockerfile.
Required properties:
Property Name Description
Dockerfile Path The path or URL of the Dockerfile to build.
Plugins Guide 345
Optional properties:
Property Name Description
Image Repository The repository to assign to the image.
Tag The tag to assign to the image.
Creating a Commit Image StepThis step saves an image of a container.
Required properties:
Property Name Description
Container name or ID The ID or name of the Docker container to commit.
Optional properties:
Property Name Description
Repository The repository to commit to.
Repository tag The repository tag.
Creating an Execute Command StepThis step executes a command within a running container.
Required properties:
Property Name Description
Container The name of the container to execute a command in.
Command The command to execute.
Optional properties:
Property Name Description
Detached Mode Select to run the command in the background.
Creating an Export to Tar StepThis step exports a Docker container to a tar archive.
Part 7: Integration Plugins
346 Deployment Automation
Required properties:
Property Name Description
Container name The name of the container to export.
Tar file name The name of the new tar file.
Creating an Inspect StepThis step executes a docker inspect command on a container or instance and sets thespecified property to the result.
Required properties:
Property Name Description
Container The name of the container or instance
Type Select the type to inspect. Options include:
• container
• instance
Property Name The property to set with the results of the command
Optional properties:
Property Name Description
Template The template to use to format the output
Creating an Import from Tar StepThis step imports a Docker image from a tar archive.
Required properties:
Property Name Description
Tar Path or URL The URL or local path of a tar archive to import from.
Local path Select if the provided path is a local file.
Creating a Pull Image StepThis step pulls an image from the Docker hub.
Plugins Guide 347
Required properties:
Property Name Description
Image Name The name of the Docker image to pull.
Creating a Push Image StepThis step pushes an image to the Docker hub.
Required properties:
PropertyName
Description
Imagename
The name of the Docker image to push in the format user/repo. Forexample: myusername/hello-world
Optional properties:
Property Name Description
Private Repository Select if the entered image repository is private.
Username Enter the username for private repository access.
Password Enter the password for private repository access.
Email Enter the email address for private repository access.
Creating a Remove Container StepThis step removes one or more containers.
Required properties:
PropertyName
Description
Container Enter the name of the container to remove. For multiple values,separate by a single space.
Optional properties:
Property Name Description
Force Removal Force removal of the container.
Part 7: Integration Plugins
348 Deployment Automation
Creating a Restart Container StepThis step restarts one or more containers.
Required properties:
PropertyName
Description
Container Enter the name of the container to restart. For multiple values,separate by a single space.
Optional properties:
Property Name Description
Timer Number of seconds to wait for stop before restarting the container
Creating a Run Command StepThis step starts an instance of a Docker image and runs a command on it.
Required properties:
Property Name Description
Container name The name to assign to the new container.
Image name The name of the Docker image to start an instance of.
Command The command to be run in the new container.
Creating a Save Image StepThis step saves an image to a tar archive.
Required properties:
PropertyName
Description
Image(s) The name of the image to archive. Separate multiple values with asingle space.
Plugins Guide 349
Optional properties:
Property Name Description
Output file name The name of the tar archive to create.
Creating a Start Container StepThis step starts one or more containers.
Required properties:
PropertyName
Description
Containers The name of the container to start. Separate multiple values with asingle space.
Optional properties:
Property Name Description
Attach STDOUTand STDERR
Select to attach the container's STDOUT and STDERR andforward all signals of the process.
Command to run The program to start the container with. The default value is/bin/bash
Creating a Stop Container StepThis step stops one or more containers.
Required properties:
PropertyName
Description
Container The name of the container to stop. Separate multiple values with asingle space.
Optional properties:
Property Name Description
Timer Number of seconds to wait before killing the container.
Part 7: Integration Plugins
350 Deployment Automation
Creating a Tag Image StepThis step tags an image.
Required properties:
Property Name Description
Tag The name of the tag
Image The name of the image to tag
Optional properties:
Property Name Description
Force Tag Force tag of the container.
Plugins Guide 351
Part 7: Integration Plugins
352 Deployment Automation
Chapter 47: Informatica Plugin
Informatica Data Services enables you to directly access and merge data across remotesystems in your organization.
The Informatica plugin is executed during deployment to migrate Informaticaconfigurations, run scripts against the Informatica server, and create and deploy groups.
In the Process Editor Available Plugin Steps, navigate to Middleware > BusinessIntelligence > Informatica.
This plugin has the following steps for you to add to your processes:
• Create Static Deployment Group
• Create Dynamic Deployment Group
• Deploy Deployment Group
• Roll Back Deployment Group
• Validate Deployment Group
• Apply Label
• Run PMREP Command
• Import Objects
For information about Informatica, see http://www.informatica.com/us/.
Plugins Guide 353
Part 7: Integration Plugins
354 Deployment Automation
Chapter 48: Microsoft BizTalk Plugin
Microsoft Biztalk Server is an enterprise service bus (ESB). It enables remote systems tocommunicate based on business rules defined in the BizTalk application.
The BizTalk plugin is used during deployment to import BizTalk applications and bindings,uninstall BizTalk applications, remove BizTalk applications, and execute BizTalk runbookautomations.
The BizTalk plugin relies on powershell and the bts executable to import new or updatedBizTalk applications, start and stop BizTalk applications, and remove or uninstall BizTalkApplications.
In the Process Editor Available Plugin Steps, navigate to Middleware > EnterpriseService Bus > BizTalk.
This plugin has the following steps for you to add to your processes:
• Export BizTalk Application
• Export BizTalk Application Bindings
• Import or Upgrade BizTalk Application
• Restart BizTalk host
• Remove BizTalk Application
• Uninstall BizTalk Application
• Start BizTalk Application
For information about BizTalk, see http://www.microsoft.com/en-us/biztalk/default.aspx.
Plugins Guide 355
Part 7: Integration Plugins
356 Deployment Automation
Chapter 49: Oracle Business IntelligencePlugin
Oracle Business Intelligence Foundation Suite is a solution for enterprise businessintelligence needs, such as reporting, ad hoc queries, OLAP, dashboards, scorecards, andwhat-if analysis.
The Oracle Business Intelligence plugin enables you to work with Oracle BusinessIntelligence services as part of your Deployment Automation processes.
In the Process Editor Available Plugin Steps, navigate to Integration > Oracle >Business Intelligence.
This plugin has the following steps for you to add to your processes:
• Creating a Create Parent Folder Step [page 357]
• Creating a Delete Folder Step [page 358]
• Creating an Unarchive Step [page 358]
For information about Oracle Business Intelligence, see http://www.oracle.com/us/solutions/business-analytics/business-intelligence/overview/index.html.
Creating a Create Parent Folder StepThis step creates an Oracle BI Presentation Catalog.
Required properties:
PropertyName
Description
ServiceURL
Specify the service URL in the following format:
http://server:port/
or
http://server:port/analytics/saw.dll
UserName
Specify the user name to use to authenticate.
Path Specify the location in the catalog where the folder should be created,including the name of the new folder.
Plugins Guide 357
Optional properties:
Property Name Description
Password Specify the password for the user.
Create Intermediate Folders Select this if intermediate directories should be created.
Creating a Delete Folder StepThis step deletes a folder and its contents from the Oracle BI Presentation Catalog.
Required properties:
PropertyName
Description
ServiceURL
Specify the service URL in the following format:
http://server:port/
or
http://server:port/analytics/saw.dll
UserName
Specify the user name to use to authenticate.
Path Specify the location in the catalog where the folder should be deleted,including the name of the folder to be deleted.
Optional properties:
PropertyName
Description
Password Specify the password for the user.
Recursive Select this if the folder is not empty and its content should also beremoved.
Creating an Unarchive StepThis step uploads and extracts an archive into the Oracle BI Presentation Catalog.
Part 7: Integration Plugins
358 Deployment Automation
Required properties:
PropertyName
Description
Service URL Specify the service URL in the following format:
http://server:port/
or
http://server:port/analytics/saw.dll
Password Specify the password for the user.
Folder Specify the folder in the catalog into which to unarchive.
Input File Specify the path to the archive that should be uploaded into OracleBI.
Optional properties:
PropertyName
Description
Password Specify the password for the user.
Overwrite Specifies whether the pasted item should overwrite the existing item.Options are:
• replace all (default option)
• replace old
• replace none
• force replace
ACL Specifies whether the item is pasted with security. Options are:
• Inherit (default option)
• preserve
• preserveOnlyGroups
• create
• createOnlyGroups
Plugins Guide 359
Part 7: Integration Plugins
360 Deployment Automation
Chapter 50: Puppet Plugin
Puppet Enterprise is IT automation software that enables you to automate repetitivetasks, deploy applications, and manage infrastructure.
The Puppet plugin enables you to list information about and modify various PuppetEnterprise Console objects as part of your Deployment Automation processes. Some stepsrequire user intervention during the execution of the process.
Note: The Puppet plugin invokes commands using the Rake API, which must berun using sudo. Therefore, if your agent is not running as superuser, theprocess will stop and require entry of the superuser password, which the userrunning the process would not necessarily know. To avoid this situation, you caneither run the agent as superuser, or you can use the Use Impersonation optionto enter the superuser user name and password that should be used by the stepto log in and successfully execute the Puppet commands.
In the Process Editor Available Plugin Steps, navigate to Integration >Configuration Management > Puppet.
This plugin has the following steps for you to add to your processes:
• Creating a List Class Info Step [page 362]
• Creating a List Group Info Step [page 362]
• Creating a List Node Info Step [page 362]
• Creating a Modify Class Info Step [page 363]
• Creating a Modify Group Info Step [page 364]
• Creating a Modify Node Info Step [page 366]
For information about Puppet, see http://puppetlabs.com.
Plugins Guide 361
Creating a List Class Info StepThis step lists the classes available on the server.
Required properties:
PropertyName
Description
Match Pattern Enter an optional regular expression to filter the names of nodeclasses to list.
Optional properties: None
Creating a List Group Info StepThis step lists information associated with a given node group on the server.
Required properties:
PropertyName
Description
Action Select the group information action to perform. Options include:
• Groups
• Classes
• Class Parameters
• Children
GroupName
Enter group name information as follows:
• For Groups, enter a regular expression to filter names of groups. Tolist all groups on the server, enter *.
• For all other options, enter the name of group for which you arerequesting information.
Optional properties: None
Creating a List Node Info StepThis step lists information associated with a given node on the server.
Part 7: Integration Plugins
362 Deployment Automation
Required properties:
PropertyName
Description
Action Select the type of information to list for the given node. Options include:
• Nodes
• Classes
• Class Parameters
• Groups
• Variables
NodeName
Enter node name information as follows:
• For Nodes, enter a regular expression to filter names of nodes. To listall nodes on the server, enter *.
• For all other options, enter the node for which to list information.
Optional properties:
Property Name Description
Class Name For Class Parameters, enter the class for which to list parameters.
Required for Class Parameters
Creating a Modify Class Info StepThis step modifies information associated with a given class on the server.
Required properties:
Property Name Description
Action Select the class modification action to perform. Options include:
• Add
• Delete
Class Enter the node class to be added or deleted from the server.
Plugins Guide 363
Optional properties:
PropertyName
Description
On Exists For Add, select the action to take if the class being added alreadyexists. Options include:
• Fail
• Skip
Required for Add
Creating a Modify Group Info StepThis step modifies information associated with a given node group on the server.
Required properties:
Property Name Description
Action Select the group modification action to perform.
Options include:
• Add
• Delete
• Add All Nodes
• Add Class
• Replace Classes
• Add Class Parameter
• Add Child
• Delete Class
• Delete Class Parameter
• Delete Child
• Edit Variables
Group Name Enter the group for which to modify information.
Part 7: Integration Plugins
364 Deployment Automation
Optional properties:
PropertyName
Description
Child For Add Child or Delete Child, enter the child group to add or delete.
Required for:
• Add Child
• Delete Child
Classes Enter class information as follows:
• For Add, enter the classes to assign to the newly-added group.
• For Replace Classes, enter all classes to assign to the group.
• For Add Class and Delete Class, enter the class to add or delete fromthe group.
• For Add Class Parameter and Delete Class Parameter, enter the classto add or delete from parameter.
For multiple classes, use a line-separated list.
Required for:
• Replace Classes
• Add Class
• Delete Class
• Add Class Parameter
• Delete Class Parameter
Parameter For Add Class Parameter and Delete Class Parameter, enter theparameter to be added or deleted.
Required for:
• Add Class Parameter
• Delete Class Parameter
ParameterValue
For Add Class Parameter, enter the value to assign to the new parameter.
Required for Add Class Parameter
Plugins Guide 365
PropertyName
Description
Variables For Edit Variables, enter the list of variables and the values to assign toeach. Specify this as VARIABLE=VALUE. For multiple variables, use a line-separated list.
Required for Edit Variables
On Exists For Add, select the action to take if the group being added already exists.Options include:
• Fail
• Skip
Required for Add
Creating a Modify Node Info StepThis step modifies information associated with a given node on the server.
Required properties:
Property Name Description
Action Select the node modification action to perform. Options include:
• Add
• Delete
• Replace Classes
• Replace Groups
• Add Class
• Add Class Parameter
• Add Group
• Delete Class Parameter
• Edit Variables
Node Name Enter the node for which to modify information.
Part 7: Integration Plugins
366 Deployment Automation
Optional properties:
PropertyName
Description
Groups Enter group information as follows:
• For Add, enter the groups to assign to the newly-added node.
• For Replace Groups, enter all groups to assign to the node.
• For Add Group, enter the group to assign to the node.
For multiple groups, use a line-separated list.
Required for:
• Replace Groups
• Add Group
Classes Enter class information as follows:
• For Add, enter the classes to assign to the newly-added node.
• For Replace Classes, enter all classes to assign to the node.
• For Add Class, enter the class to assign to the node.
• For Add Class Parameter and Delete Class Parameter, enter the classto add to or delete from the parameter.
For multiple classes, use a line-separated list.
Required for:
• Replace Classes
• Add Class
• Add Class Parameter
• Delete Class Parameter
Parameter For Add Class Parameter and Delete Class Parameter, enter theparameter to be added or deleted.
Required for:
• Add Class Parameter
• Delete Class Parameter
Plugins Guide 367
PropertyName
Description
ParameterValue
For Add Class Parameter, enter the value to assign to the new parameter.
Required for Add Class Parameter
Variables For Edit Variables, enter the list of variables and the values to assign toeach, specified as VARIABLE=VALUE.
For multiple variables, use a line-separated list.
Required for Edit Variables
On Exists For Add, select the action to take if the node being added already exists.
Options include:
• Fail
• Skip
Required for Add
Part 7: Integration Plugins
368 Deployment Automation
Chapter 51: Web Services Plugin
The WebServices plugin helps with SOAP and REST services invocation. It enables usersto process service responses either through step properties or through a separate file.
In the Process Editor Available Plugin Steps, navigate to Integration > WebServices.
This plugin has the following steps for you to add to your processes:
• Creating an Invoke REST Service Step [page 369]
• Creating an Invoke DA Service Step [page 371]
• Creating an Invoke SOAP Service Step [page 373]
Creating an Invoke REST Service StepThis step performs a remote REST service request and stores the result.
Required properties:
Property Name Description
URL Enter the URL to the remote REST service.
Optional properties:
PropertyName
Description
User Name User name of the remote user
Password Password of the remote user
Plugins Guide 369
PropertyName
Description
Requestmethod
The action to be performed.
Options include:
• GET (default)
• POST
• PUT
• DELETE
• HEAD
• TRACE
• OPTIONS
RequestBody
The body of the request to be performed
Destination The location where the execution result will be saved.
Options include:
• Step properties (default)
• File
• None
Responsefile
Path to the file where the response will be saved
Statusexpression
An expression in the response to process for the step result. Specifythis in one of the following formats:
<result property>=<success value>
A Groovy script, starting with the comment //GROOVY
HTTPHeaders
This field contains HTTP headers that will be added to the request.Specify each on a new line, with the header name separated from thevalue with '='.
For example:
token=Zy65QnbGf
Part 7: Integration Plugins
370 Deployment Automation
PropertyName
Description
Content file Path to the file containing the request body. The contents will be usedas the request body instead of the Request Body field content.
Contenttype
The MIME type of the request content.
Attachments Attachment properties should be specified as line-separated strings inthe following format:
<property name>[<index>]=<property value>
Allowed properties are:
• type (text or binary)
• name (attachment name)
• file (path to a file with attachment content)
• contentType (MIME type of the attachment content) [OPTIONAL]
• fileName (binary attachment file name) [OPTIONAL]
Add indexes if there is more than one attachment. For example:
type[0]=textname[0]=My Text Filefile[0]=c:\Temp\MyFile.txttype[1]= binaryname[1]=My Exec Filefile[1]=c:\Temp\MyFile3.exefileName[1]=NewFileName.exe
Debug logs Add debug information to logs.
Creating an Invoke DA Service StepThis step performs a remote Deployment Automation service request and stores theresult.
Required properties:
PropertyName
Description
URL Enter the current Deployment Automation REST service URL. Relativeand full URLs are allowed.
Plugins Guide 371
Optional properties:
PropertyName
Description
Requestmethod
The action to be performed. Options include:
• GET (default)
• POST
• PUT
• DELETE
RequestBody
The body of the request to be performed
Destination The location where the execution result will be saved. Options include:
• Step properties (default)
• File
• None
Responsefile
Path to the file where the response will be saved
User Name User name of the remote user
Password Password of the remote user
Statusexpression
Enter an expression in the response to process for the step result.Specify this in one of the following formats:
<result property>=<success value>
As a Groovy script, starting with the comment //GROOVY
HTTPHeaders
This field contains HTTP headers that will be added to the request.Specify each on a new line, with the header name separated from valuewith '='.
For example:
token=Zy65QnbGf
Content file Enter the path to the file containing the request body. The contents willbe used as the request body instead of the Request Body field content.
Part 7: Integration Plugins
372 Deployment Automation
PropertyName
Description
Contenttype
The MIME type of the request content
Attachments Attachment properties should be specified as line-separated strings inthe following format:
<property name>[<index>]=<property value>
Allowed properties are:
• type (text or binary)
• name (attachment name)
• file (path to a file with attachment content)
• contentType (MIME type of the attachment content) [OPTIONAL]
• fileName (binary attachment file name) [OPTIONAL]
Add indexes if there is more than one attachment. For example:
type[0]=textname[0]=My Text Filefile[0]=c:\Temp\MyFile.txttype[1]= binaryname[1]=My Exec Filefile[1]=c:\Temp\MyFile3.exefileName[1]=NewFileName.exe
Debug logs Add debug information to logs.
Creating an Invoke SOAP Service StepThis step performs a remote SOAP service request and stores the result.
For an example, see the Community.
Required properties:
Property Name Description
WSDL URL Specify the URL to the remote SOAP service WSDL description.
For example:
http://server_hostname:8080/service/wsdl_file.wsdl
Operation Specify the name of the operation to be requested.
Plugins Guide 373
Optional properties:
PropertyName
Description
User Name User name of the remote user
Password Password of the remote user
RequestBody
Enter the SOAP request body in XML format. If this is omitted, the rootelement defaults to the operation name.
Statusexpression
An expression in a SOAP response to process for the step result. Specifythis in one of the following formats:
<result property> = <success value>
A Groovy script, starting with the comment //GROOVY
Destination The location where the execution result will be saved.
Options include:
• Step properties (default)
• File
• None
Responsefile
Path to the file where result will be saved if File is selected in theprevious step
EndpointURL
URL to the remote SOAP service
SOAPHeader
This field contains an XML header that will be added to the request. Theroot element <Header> may be omitted unless your server requires it.
HTTPHeaders
This field contains HTTP headers that will be added to the request.Specify each on a new line, with the header name separated from valuewith '='.
For example:
token=Zy65QnbGf
Debug logs Add debug information to logs.
Part 7: Integration Plugins
374 Deployment Automation
Part 8: Network Management Plugins
This section contains the following information:
• Chapter 52: Citrix NetScaler Plugin [page 377]
• Chapter 53: F5 BIG-IP Plugin [page 385]
• Chapter 54: Nagios XI Plugin [page 387]
Plugins Guide 375
Part 8: Network Management Plugins
376 Deployment Automation
Chapter 52: Citrix NetScaler Plugin
Citrix NetScaler makes applications and cloud-based services run faster by offloadingapplication and database servers, accelerating their performance, and integratingsecurity. NetScaler can be deployed before deploying Web and database servers tocombine high-speed load balancing and content switching, data compression, contentcaching, SSL acceleration, network optimization, application visibility, and applicationsecurity.
In the Process Editor Available Plugin Steps, navigate to Infrastructure > LoadBalancing > NetScaler.
This plugin has the following steps for you to add to your processes:
• Creating a NetScaler Check Service Group Bindings Step [page 377]
• Creating a NetScaler Check Service Group Status Step [page 378]
• Creating a NetScaler Check Service Status Step [page 379]
• Creating a NetScaler Disable Servers Step [page 380]
• Creating a NetScaler Disable Services Step [page 380]
• Creating a NetScaler Disable Service Groups Step [page 381]
• Creating a NetScaler Enable Servers Step [page 382]
• Creating a NetScaler Enable Services Step [page 382]
• Creating a NetScaler Enable Service Groups Step [page 383]
• Creating a NetScaler Save Configuration Step [page 384]
For information about Citrix Netscaler, see http://www.citrix.com/products/.
Creating a NetScaler Check Service Group BindingsStepThis step checks the status of servers bound to a given service group.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Plugins Guide 377
PropertyName
Description
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
AllowedStates
A comma separated list of allowed states for service group members
ServiceGroupName
Name of the service group
Timeout(seconds)
Specify the time to wait until the specified service groups reach theexpected status. Set to 0 to check only once; the default value is 0.
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Creating a NetScaler Check Service Group Status StepThis step checks the status of service groups in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ExpectedState
The expected state for the listed service groups
ServiceGroupList
A comma and/or new-line separated list of service groups for which tocheck the status
Part 8: Network Management Plugins
378 Deployment Automation
PropertyName
Description
Timeout(seconds)
Specify the time to wait until all members reach the expected status. Setto 0 to check only once; the default value is 0.
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Creating a NetScaler Check Service Status StepThis step checks the status of service groups in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ExpectedState
The expected state for the listed services
ServiceGroupList
A comma and/or new-line separated list of services for which to check thestatus
Timeout(seconds)
Specify the time to wait until the specified services reach the expectedstatus. Set to 0 to check only once; the default value is 0.
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Plugins Guide 379
Creating a NetScaler Disable Servers StepThis step disables one or more servers in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ServerList
A comma and/or new line separated list of servers to disable
Wait time(seconds)
The remaining time in seconds for the servers to be disabled; the defaultis 0
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Gracefulshutdown
Wait for connections to drain from servers before shutting down
Creating a NetScaler Disable Services StepThis step disables one or more services in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Part 8: Network Management Plugins
380 Deployment Automation
PropertyName
Description
Password Password to login to the NetScaler appliance
ServerList
A comma and/or new line separated list of services to disable
Wait time(seconds)
The remaining time in seconds for the services to be disabled; the defaultis 0
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Gracefulshutdown
Wait for connections to drain from services before shutting down
Creating a NetScaler Disable Service Groups StepThis step disables one or more service groups in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ServiceGroupList
A comma and/or new line separated list of service groups to disable
Wait time(seconds)
The remaining time in seconds for the service groups to be disabled; thedefault is 0
Plugins Guide 381
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Gracefulshutdown
Wait for connections to drain from services before shutting down
Creating a NetScaler Enable Servers StepThis step enables one or more servers in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ServerList
A comma and/or new line separated list of servers to enable
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Creating a NetScaler Enable Services StepThis step enables one or more services in NetScaler.
Part 8: Network Management Plugins
382 Deployment Automation
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ServiceList
A comma and/or new line separated list of services to enable
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Creating a NetScaler Enable Service Groups StepThis step enables one or more service groups in NetScaler.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
ServiceGroupList
A comma and/or new line separated list of service groups to enable
Plugins Guide 383
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Creating a NetScaler Save Configuration StepThis step saves the Netscaler configuration.
Required properties:
PropertyName
Description
ServerURL
URL to the NetScaler appliance. This is the IP or domain name of theappliance including the protocol and port number, such ashttps://netscaler.domain.com:8443 or http://10.1.2.3. The defaultvalue is ${p:environment/NetScaler/serverURL}.
Username Username to login to the NetScaler appliance
Password Password to login to the NetScaler appliance
Optional properties:
Property Name Description
Allow untrustedcertificates
Establish an HTTPS connection even if the certificate is not signedby any of the issuing authorities.
Part 8: Network Management Plugins
384 Deployment Automation
Chapter 53: F5 BIG-IP Plugin
F5 BIG-IP provides functionality such as network load balancing, access control, andapplication security for Web-based applications.
In the Process Editor Available Plugin Steps, navigate to Infrastructure > LoadBalancing > F5.
This plugin has the following steps for you to add to your processes:
• Disable node in pool
• Disable node in all pools
• Enable node in pool
• Enable node in all pools
• Add node to pool
• Remove node from pool
• Create pool
• Delete pool
For information about F5 BIG-IP, see http://www.f5.com/.
Plugins Guide 385
Part 8: Network Management Plugins
386 Deployment Automation
Chapter 54: Nagios XI Plugin
Nagios XI enables you to monitor critical infrastructure components such as applications,services, operating systems, network protocols, system metrics and networkinfrastructure.
In the Process Editor Available Plugin Steps, navigate to Infrastructure >Monitoring > Nagios.
This plugin has the following steps for you to add to your processes:
• Disable Host Notifications
• Enable Host Notifications
• Disable Group Notifications
• Enable Group Notifications
For information about Nagios XI, see http://www.nagios.com/products/nagiosxi.
Plugins Guide 387
Part 8: Network Management Plugins
388 Deployment Automation
Part 9: Quality and Test ManagementPlugins
This section contains the following information:
• Chapter 55: Deploy Tools Plugin [page 391]
• Chapter 56: HP Quality Center Plugin [page 393]
• Chapter 57: QuickTest Pro Plugin [page 403]
• Chapter 58: Rally Plugin [page 405]
• Chapter 59: Selenium Plugin [page 407]
• Chapter 60: Silk Central Plugin [page 409]
Plugins Guide 389
Part 9: Quality and Test Management Plugins
390 Deployment Automation
Chapter 55: Deploy Tools Plugin
Deploy Tools enables you to verify the deployment of an application through an HTTPinterface.
The Deploy Tools plugin provides automated post-deployment verification.
In the Process Editor Available Plugin Steps, navigate to Quality > FunctionalTesting > Simple Web Test.
This plugin has the following steps for you to add to your processes:
• Verify Deployment
• Wait for web page
Plugins Guide 391
Part 9: Quality and Test Management Plugins
392 Deployment Automation
Chapter 56: HP Quality Center Plugin
HP Quality Center (HP QC) provides quality assurance through requirementsmanagement, release and cycle management, test management, defects management,and reporting.
The HP QC plugin automates the creating and deleting of issues in HP QC among othertasks.
In the Process Editor Available Plugin Steps, navigate to Quality > Suites >HPQualityCenter.
This plugin has the following steps for you to add to your processes:
• Creating a Create Issue Step [page 393]
• Creating an Update Issues Step [page 394]
• Creating an Add Comments Step [page 396]
• Creating a Publish Issue Report Step [page 397]
• Creating a Run Test Set Step [page 398]
• Creating a Publish Test Set Report Step [page 398]
• Creating a Check Status Step [page 399]
• Creating a Query Defects Step [page 400]
For information about HP QC, see http://www8.hp.com/uk/en/software-solutions/software.html?compURI=1172141.
Creating a Create Issue StepThis step creates a new defect in HP Quality Center.
Required properties:
PropertyName
Description
Server URL The base URL of the Quality Center instance. In usually ends with/qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
Plugins Guide 393
PropertyName
Description
Project Key The project key in Quality Center.
Assignee The user the new defect is assigned to.
Summary A summary for the new defect. By default, the max length is 255.
Detected By The person who found the defect.
Detected OnDate
The date the defect was detected. This is supplied using the format MM/
DD/YYYY.
Detected InVersion
The version in which the defect was detected.
Reproducible Whether the defect is reproducible or not (Y/N).
Subject The subject of the defect.
Severity The severity of the new defect. The default values are: 1-Low,2-Medium, 3-High, 4-Very High, and 5-Urgent.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Priority The priority of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.
Status The status of the new defect. The default values are: Closed, Fixed, New,Open, Rejected and Reopen. The default value is New.
AdditionalFields
Additional defect fields to add. This is provided as a newline-separated listin the form name=value. Uses Java’s java.util.Properties format.
Creating an Update Issues StepThis step updates one or more defects in HP Quality Center.
Part 9: Quality and Test Management Plugins
394 Deployment Automation
Required properties:
PropertyName
Description
ServerURL
The base URL of the Quality Center instance. In usually ends with /qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
DefectIDs
Comma-separated list of defect IDs to update.
Fail Mode The action that should be taken when a defect to be updated is not foundin Quality Center. Select one of the following values:
• Fail-fast: Fail the step immediately if a defect is not found.
• Fail: Fail the step after attempting to update all defects.
• Warn: Log a warning when a defect is not found.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Assignee The user the new defect is assigned to.
Summary A summary for the new defect. By default, the max length is 255.
Priority The priority of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.
Severity The severity of the new defect. The default values are: 1-Low, 2-Medium,3-High, 4-Very High, and 5-Urgent.
Status The status of the new defect. The default values are: Closed, Fixed, New,Open, Rejected and Reopen. The default value is New.
Plugins Guide 395
PropertyName
Description
AdditionalFields
Additional defect fields to add. This is provided as a newline-separated listin the form name=value. Uses Java’s java.util.Properties format.
Comment A comment to add to the update.
Creating an Add Comments StepThis step adds comments to a defect in HP Quality Center.
Required properties:
PropertyName
Description
ServerURL
The base URL of the Quality Center instance. In usually ends with /qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
DefectIDs
Comma-separated list of defect IDs to update.
Fail Mode The action that should be taken when a defect to be updated is not foundin Quality Center. Select one of the following values:
• Fail-fast: Fail the step immediately if a defect is not found.
• Fail: Fail the step after attempting to update all defects.
• Warn: Log a warning when a defect is not found.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Part 9: Quality and Test Management Plugins
396 Deployment Automation
PropertyName
Description
AdditionalComments
Additional information you can add to the Quality Center commentalong with the commit comment.
Creating a Publish Issue Report StepThis step creates a report of Quality Center defects from a list of defect IDs.
Required properties:
PropertyName
Description
ServerURL
The base URL of the Quality Center instance. In usually ends with /qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
DefectIDs
Comma-separated list of defect IDs to update.
OutputFile
The output file for results.
Fail Mode The action that should be taken when a defect to be updated is not foundin Quality Center. Select one of the following values:
• Fail-fast: Fail the step immediately if a defect is not found.
• Fail: Fail the step after attempting to update all defects.
• Warn: Log a warning when a defect is not found.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Plugins Guide 397
Creating a Run Test Set StepThis step runs a test set using HP Quality Center.
Required properties:
PropertyName
Description
Server URL The base URL of the Quality Center instance. In usually ends with/qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
Folder The folder in Quality Center in which the test set resides. Usuallystarts with Root.
Test Set The test set to run.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
RemoteHost
The host that runs the tests. If this is left empty, then the tests will runlocally.
Creating a Publish Test Set Report StepThis step publishes an HP Quality Center Test Set Report.
Required properties:
PropertyName
Description
Server URL The base URL of the Quality Center instance. In usually ends with/qcbin.
Username The username to authenticate with Quality Center.
Part 9: Quality and Test Management Plugins
398 Deployment Automation
PropertyName
Description
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
Folder The folder in Quality Center in which the test set resides. Usuallystarts with Root.
Test Set The test set results to publish.
Report Name The name that will be given to the report.
Output File The output file for results.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Creating a Check Status StepThis step ensures the status of issues are in the expected state.
Required properties:
PropertyName
Description
ServerURL
The base URL of the Quality Center instance. In usually ends with /qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
DefectIDs
A comma-separated list of defect IDs to update in HP Quality Center.
Plugins Guide 399
PropertyName
Description
ExpectedStatus
The status that the issues are expected to have.
Fail Mode The action that should be taken when a defect to be updated is not foundin Quality Center. Select one of the following values:
• Fail-fast: Fail the step immediately if a defect is not found.
• Fail: Fail the step after attempting to update all defects.
• Warn: Log a warning when a defect is not found.
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
Creating a Query Defects StepThis step queries defects in HP Quality Center.
Required properties:
PropertyName
Description
Server URL The base URL of the Quality Center instance. In usually ends with/qcbin.
Username The username to authenticate with Quality Center.
Domain The domain for the defect in Quality Center
Project The project for the defect in Quality Center.
Part 9: Quality and Test Management Plugins
400 Deployment Automation
Optional properties:
PropertyName
Description
Password The password to authenticate with Quality Center.
PasswordScript
If a property or script is used to obtain the password, enter it here andleave the password property empty.
MatchCriteria
A newline-separated list of criteria names to filter by. For example:Created in Application = XXXXXXXXXX.
ReturnFields
A newline-separated list of fields to return.
Plugins Guide 401
Part 9: Quality and Test Management Plugins
402 Deployment Automation
Chapter 57: QuickTest Pro Plugin
QuickTest Pro (QTP) enables you to automate functional and regression tests. It canperform operations such as mouse clicks or keyboard events on objects in a GUI or Webpage.
In the Process Editor Available Plugin Steps, navigate to Quality > FunctionalTesting > QTP.
This plugin has the following steps for you to add to your processes:
• Run QuickTestPro tests
For information about QuickTest Pro, see http://www.th-hp.com/hp-products.php?gclid=CNzr7eaGm7cCFRLLtAodoT4APg#QTP.
Plugins Guide 403
Part 9: Quality and Test Management Plugins
404 Deployment Automation
Chapter 58: Rally Plugin
Rally is an agile project management tool that help large enterprises perfect the art ofagile development and bring products to market faster.
The Rally plugin enables you to update Rally issues for bug or feature tracking.
In the Process Editor Available Plugin Steps, navigate to Issue Tracking > Rally.
This plugin has the following steps for you to add to your processes:
• Add Comments
• Change Status
• Create Defect
• Change Rally Artifact Property
For information about Rally, see http://www.rallydev.com/.
Plugins Guide 405
Part 9: Quality and Test Management Plugins
406 Deployment Automation
Chapter 59: Selenium Plugin
Selenium is a testing tool which automates Web applications. It can also be used toautomate basic browser functions and administration tasks.
The Selenium plugin runs Selenium Remote Control (RC) commands using a SeleniumHTML test suite file.
In the Process Editor Available Plugin Steps, navigate to Quality > FunctionalTesting > Selenium.
This plugin has the following steps for you to add to your processes:
• Run Test Suite
For information about Selenium, see http://www.seleniumhq.org/.
Plugins Guide 407
Part 9: Quality and Test Management Plugins
408 Deployment Automation
Chapter 60: Silk Central Plugin
Micro Focus Silk Central enables you to gain control, collaboration and traceability acrossall areas of your software testing, whether your methodology is Agile, Traditional orhybrid. Silk Central provides integration of requirements, manual and automated tests,defect tools and your test execution, giving full traceability of the quality of your softwaretesting regardless of role.
The Silk Central plugin enables you to run and view plans using Silk Central.
In the Process Editor Available Plugin Steps, navigate to Quality > Silk Central.
This plugin has the following steps for you to add to your processes:
• Creating an Execute Single Plan Step [page 409]
• Creating an Execute Multiple Plans Step [page 410]
For information about Silk Central, see http://www.microfocus.com/products/silk-portfolio/silk-central/.
Creating an Execute Single Plan StepThis step allows you to execute a single pre-defined plan.
Required properties:
Property Name Description
Host Name The host name of the Silk Central server to which you want toconnect
Port The port of the Silk Central server to which you want to connect
User ID A Silk Central server user ID
Password A Silk Central server password
Execution PlanID
The ID of an execution tree node
Build ID The identifier of an existing build
Plugins Guide 409
Optional properties:
PropertyName
Description
RunOption
Options for executing the tests
SinceBuild
Specify the build number from which to start executing the tests. This willwork only with selection 3 or 4 under Run Option.
Creating an Execute Multiple Plans StepThis step allows you to execute multiple pre-defined plans.
Required properties:
PropertyName
Description
Host Name The host name of the Silk Central server to which you want toconnect
Port The port of the Silk Central server to which you want to connect
User ID A Silk Central server user ID
Password A Silk Central server password
Parent FolderID
Parent folder ID or the ID of an execution tree node
Optional properties: None.
Part 9: Quality and Test Management Plugins
410 Deployment Automation
Part 10: System Tools and Scripting Plugins
This section contains the following information:
• Chapter 61: 7zip Plugin [page 413]
• Chapter 62: CA AutoSys Plugin [page 415]
• Chapter 63: Email Client Plugin [page 417]
• Chapter 64: FileUtils Plugin [page 419]
• Chapter 65: Groovy Plugin [page 421]
• Chapter 66: Linux System Tools Plugin [page 423]
• Chapter 67: Log Parser Plugin [page 429]
• Chapter 68: Microsoft Message Queuing (MSMQ) Plugin [page 435]
• Chapter 69: Microsoft Software Installer (MSI) Plugin [page 437]
• Chapter 70: MS Windows PowerShell Plugin [page 439]
• Chapter 71: MS Windows Service Control Manager Plugin [page 441]
• Chapter 72: MS Windows System Tools Plugin [page 443]
• Chapter 73: Red Hat Package Manager (RPM) Plugin [page 453]
• Chapter 74: Shell Plugin [page 455]
• Chapter 75: System Information Plugin [page 457]
Plugins Guide 411
Part 10: System Tools and Scripting Plugins
412 Deployment Automation
Chapter 61: 7zip Plugin
7zip is an open source file archiver that combines a number of files together into a singlefile for easier transportation and storage.
In the Process Editor Available Plugin Steps, navigate to System Utility > 7zip.
This plugin has the following steps for you to add to your processes:
• Creating a 7zip Extract Archive Step [page 413]
For information about 7zip, see http://www.7-zip.org/.
Creating a 7zip Extract Archive StepYou may use this step to extract files from a 7zip archive.
To create a 7zip extract archive step:
1. Enter the Name for your extract archive step.
2. Use the Include Files field to list the file filters you want this step to use to selectthe files to include.
Important: Files must each be listed on a new line separated from thenext.
3. Specify from where the files should be extracted in the Extract Directory field.
4. (Optional) You may choose to specify the following:
a. The Directory Offset relative to the current working directory where the stepshould run.
b. Use the Exclude Files field to list file filters you want this step to exclude fromusing.
Important: Files must each be listed on a new line separated from thenext.
Plugins Guide 413
Part 10: System Tools and Scripting Plugins
414 Deployment Automation
Chapter 62: CA AutoSys Plugin
CA Workload Automation AutoSys Edition is a workload automation tool for defining,scheduling, and monitoring jobs.
The AutoSys plugin provides steps for integrating with a CA Workload Automation AEserver.
In the Process Editor Available Plugin Steps, navigate to Automation > Autosys.
This plugin has the following steps for you to add to your processes:
• Send Autosys Event
• Check Autosys Server
• Execute JIL Script
For information about AutoSys, see http://www.ca.com/us/products/detail/CA-Workload-Automation-AE.aspx.
Plugins Guide 415
Part 10: System Tools and Scripting Plugins
416 Deployment Automation
Chapter 63: Email Client Plugin
The Email Client plugin enables you to send SMTP email during a deployment.
In the Process Editor Available Plugin Steps, navigate to Utilities > Misc > SendEmail.
• Creating a Send Email Step [page 417]
Creating a Send Email StepThis step sends an SMTP email.
Required properties:
Property Name Description
From Email address of originator.
To List Comma-separated list of email addresses to send an email to.
Message The message contents.
Email Host Name Host name of the email client.
Optional properties:
Property Name Description
Subject The email subject.
Port Port of the email client.
Username Username of the email client.
Password Password of the email client.
Plugins Guide 417
Part 10: System Tools and Scripting Plugins
418 Deployment Automation
Chapter 64: FileUtils Plugin
FileUtils is a file utility plugin that automates folder and file level tasks.
In the Process Editor Available Plugin Steps, navigate to Utilities > FileUtils.
This plugin has the following steps for you to add to your processes:
• Replace Tokens
• Untar Tarball
• Unzip
• Update Property File
• Copy Directory
• Move Directory
• Synchronize Directories
• Create Directories
• Check if Directory exists
• Delete Files and Directories
• Create File
• Update INI File
• Monitor File Contents
• Flip Line Endings
• Create Zip Archive
• Update XML File with XPath
• Read Property File
Plugins Guide 419
Part 10: System Tools and Scripting Plugins
420 Deployment Automation
Chapter 65: Groovy Plugin
Groovy is an object-oriented programming language for the Java platform. It is a dynamiclanguage that can be used as a scripting language.
The Groovy plugin provides a step for executing user-defined Groovy scripts.
In the Process Editor Available Plugin Steps, navigate to Scripting > Groovy.
This plugin has the following steps for you to add to your processes:
• Run Groovy Script
For information about Groovy, see http://groovy.codehaus.org/.
Plugins Guide 421
Part 10: System Tools and Scripting Plugins
422 Deployment Automation
Chapter 66: Linux System Tools Plugin
The Linux System Tools plugin automates various Linux system tasks, such as rebootingthe operating system and setting file permissions.
In the Process Editor Available Plugin Steps, navigate to System Utility > Linux >LinuxSystemTools.
This plugin has the following steps for you to add to your processes:
• Creating an Add User Step [page 423]
• Creating an Add Group Step [page 423]
• Creating a Change File Ownership Step [page 424]
• Creating a Reboot Step [page 425]
• Creating a Set File Permissions Step [page 425]
• Creating an Update fstab Step [page 426]
Creating an Add User StepThis step adds a user to this Linux machine.
Required properties:
Property Name Description
New user name New user name
Optional properties:
PropertyName
Description
New user'sgroup
Add a group name here if you want the user to be in an existinggroup
Creating an Add Group StepThis step adds a user group to this Linux machine.
Plugins Guide 423
Required properties:
Property Name Description
New group name New group name
Optional properties:
Property Name Description
Users to add togroup
You can optionally add existing users to this group. Enter one username per line.
Creating a Change File Ownership StepThis step sets the ownership of files and directories in the current working directory.
Required properties:
PropertyName
Description
Includes The files and directories for which to change the ownership. This is a new-line separated list of file patterns in the ant style. For example:
• **/* will match all directories and files recursively
• **/test/* will match all files and direct subfolders in a folder named"test" anywhere in the file tree
Optional properties:
PropertyName
Description
Directory Specify the directory in which to search for files. If omitted, the workdirectory of the plugin is used.
Excludes The files and directories that should be excluded, limited to those matchedby the includes. Use the same patterns as described for Includes.
Newowner
The name of the new owner
Part 10: System Tools and Scripting Plugins
424 Deployment Automation
PropertyName
Description
Type Select the file types on which to set change ownership. Options include:
• both
• file
• dir
Creating a Reboot StepThis step reboots the operating system.
Required properties:
None.
Optional properties:
Property Name Description
Time The time to reboot.; possible values are:
• now
• +m, where m is the number of minutes to wait
• hh:mm
Creating a Set File Permissions StepThis step sets the permissions of files and directories in the current working directory.
Required properties:
PropertyName
Description
Includes The files and directories for which to change the permissions. This is anew-line separated list of file patterns in the ant style. For example:
• **/* will match all directories and files recursively
• **/test/* will match all files and direct subfolders in a folder named"test" anywhere in the file tree
Plugins Guide 425
Optional properties:
PropertyName
Description
Directory Specify the directory in which to search for files. If omitted, the workdirectory of the plugin is used.
Excludes The files and directories that should be excluded, limited to thosematched by the includes. Use the same patterns as described forIncludes.
PermissionString
The permission string to apply to the matched files, such as 0777 or a+x
Type Select the file types on which to set permissions. Options include:
• both
• file
• dir
Creating an Update fstab StepThis step updates, adds, and removes rules from the fstab file.
Required properties:
None.
Optional properties:
PropertyName
Description
fstab filepath
Specify the path to the fstab file, including the file name, if it is not atthe following location:
/etc/fstab
Add/Updaterules
A new-line-separated list of rules to add or update
Removerules
A new-line-separated list of devices to remove; specify only the sourcedevice, not the full fstab rule
Backup filesuffix
Enter a value here if you want to create a backup of the original fstabfile. The value is appended to the original file name.
Part 10: System Tools and Scripting Plugins
426 Deployment Automation
PropertyName
Description
File owner Enter the owner to be set for the fstab file.
For example:
root:root
If no value is supplied, the new file owner is based on the agent processID.
Filepermissions
Enter the permissions to be set for the fstab file.
For example:
644
If no value is supplied, the new file permissions are based on the umaskvalue.
Plugins Guide 427
Part 10: System Tools and Scripting Plugins
428 Deployment Automation
Chapter 67: Log Parser Plugin
The Log Parser plugin parses log files on the Deployment Automation agent side andprovides an output log file with the results.
Use this plugin to parse log files from products that you are executing through yourprocess steps. For example, if you want to put a conditional step in your process to checkfor a specific completion code that is stored in a log, you can use Log Parser to do that.
The agent processes logs as follows:
• Logs are uploaded to the server after each step is executed and are stored on theagent side until the whole process is finished.
• The log file for each step has a distinct path to avoid conflicts with any other processrunning on the agent at the same time.
• Deployment Automation will not prevent deletion of the log files of a currentlyrunning process. If this situation occurs, the deleted files will be skipped during thelog file deletion operation in the end of the process execution.
The following built-in properties are used as the default value for Include Files in the LogParser steps:
• The prevStep property enables you to access previous step values without having toexplicitly fill in the previous step name. You can provide a property expression in thefollowing format where prevStep will resolve to the value of the previous step nameduring execution of the process.
${p:prevStep/propName}
All properties of the previous step that are accessible with the full syntax areaccessible through the prevStep property.
Warning: If a step has multiple possible previous steps in a conditionalprocess design, the results will be unpredictable.
• The logPath property is an output property that resolves to the full path of a givenstep's log file during process execution. If you specify the property expression in thefollowing format, the values will resolve to the value of the previous step name andthe log path for that step during execution of the process:
${p:prevStep/logPath}
Important: This functionality was introduced in Deployment Automationversion 5.1.5. Processes that were executed before this functionality wasimplemented will not have the logPath property.
In the Process Editor Available Plugin Steps, navigate to Utilities > LogParser.
This plugin has the following steps for you to add to your processes:
• Creating a RegExp Search Step [page 430]
Plugins Guide 429
• Creating a Convert to HTML Step [page 431]
Creating a RegExp Search StepThis step parses log files on the Deployment Automation agent side using regularexpression rule matching and provides an output log file with the results.
Required properties:
PropertyName
Description
IncludeFiles
Specify the list of files to parse, relative to the base directory. Wildcardscan be used. Specify multiple file paths as a new-line-separated list.Default value: ${p:prevStep/logPath}
Rules Specify a new-line-separated list of rules to apply to the contents of thefile. The rule format is: RuleName=RegularExpression
RuleName is the name of the rule to assign to a line if the line matches theregular expression specified in RegularExpression.
For example,
ORA_MESSAGES=ORA-\d\d\d\d
will find all the lines containing the regular expression
ORA-\d\d\d\d
and assign it to the rule name
ORA_MESSAGES.
Rules will be applied to each log line in the order of appearance in thisfield.
Optional properties:
PropertyName
Description
BaseDirectory
Specify the root directory where log parsing will be done.
ExcludeFiles
Specify the list of files to exclude from selection, relative to the basedirectory. Wildcards can be used. Specify multiple file paths as a new-line-separated list.
OutputPath
Specify the file path where the resulting output will be saved. If no file isspecified, the result is saved in the console output.
Part 10: System Tools and Scripting Plugins
430 Deployment Automation
PropertyName
Description
Group By Select the way you want the output to be grouped. Values are:
• None
• Group name
• File path
OutputFormat
Specify the output format of each line in the output log. Special propertiescan be used in this field. Each special property should be specified in thefollowing format:
${propName}
Allowed properties:
• Line
• LineNumber
• FileName
• FilePath
• GroupName
• RegExp
Default value:
\t${FileName}:${LineNumber} - ${Line}
Fail If NoFilesFound
Select this to cause the step to fail if no files matching the include andexclude file filters are found in the base directory.
Default value: Not selected
Creating a Convert to HTML StepThis step parses log files on the Deployment Automation agent side and provides an HTMLfile containing log contents and search results.
Required properties:
PropertyName
Description
IncludeFiles
Specify the list of files to parse, relative to the base directory. Wildcardscan be used. Specify multiple file paths as a new-line-separated list.Default value: ${p:prevStep/logPath}
Plugins Guide 431
PropertyName
Description
OutputPath
Specify the output file path for the resulting HTML file.
Rules Specify a new-line-separated list of rules to apply to the contents of thefile. The rule format is: RuleName=RegularExpression
RuleName is the name of the rule to assign to a line if the line matches theregular expression specified in RegularExpression.
For example,
ORA_MESSAGES=ORA-\d\d\d\d
will find all the lines containing the regular expression
ORA-\d\d\d\d
and assign it to the rule name
ORA_MESSAGES.
Rules will be applied to each log line in the order of appearance in thisfield.
Optional properties:
PropertyName
Description
BaseDirectory
Specify the root directory where log parsing will be done.
ExcludeFiles
Specify the list of files to exclude from selection, relative to the basedirectory. Wildcards can be used. Specify multiple file paths as a new-line-separated list.
Group By Select the way you want the output to be grouped. Values are:
• None
• Group name
• File path
Part 10: System Tools and Scripting Plugins
432 Deployment Automation
PropertyName
Description
OutputFormat
Specify the output format of each line in the output log. Special propertiescan be used in this field. Each special property should be specified in thefollowing format:
${propName}
Allowed properties:
• Line
• LineNumber
• FileName
• FilePath
• GroupName
• RegExp
Default value:
\t${FileName}:${LineNumber} - ${Line}
Fail If NoFilesFound
Select this to cause the step to fail if no files are found that match theinclude and exclude file filters in the base directory.
Default value: Not selected
SetColors
Specify the list of highlight colors to apply to the corresponding rules. Theformat of the field is:
RuleName
where RuleName is the name you assigned in the Rules property.
You can set one color per rule. Colors should be specified in hex format.For example:
ERROR=#FF0000WARNING= #FF8040SUCCESS=#008000
Plugins Guide 433
Part 10: System Tools and Scripting Plugins
434 Deployment Automation
Chapter 68: Microsoft Message Queuing(MSMQ) Plugin
Microsoft Message Queuing (MSMQ) technology enables applications running at differenttimes to communicate across heterogeneous networks and systems that may betemporarily offline. Applications send and read messages to and from queues. A queuecan hold messages that are generated by multiple sending applications and read bymultiple receiving applications.
In the Process Editor Available Plugin Steps, navigate to Middleware > Messaging >MicrosoftMQ.
This plugin has the following steps for you to add to your processes:
• Create Message Queue
• Delete Message Queue
• Grant All Queue Permissions
• Grant Queue Permissions
• Revoke All Queue Permissions
• Revoke Queue Permissions
For information about MSMQ, see http://msdn.microsoft.com/en-us/library/windows/desktop/ms711472(v=vs.85).aspx.
Plugins Guide 435
Part 10: System Tools and Scripting Plugins
436 Deployment Automation
Chapter 69: Microsoft Software Installer(MSI) Plugin
Microsoft Software Installer (MSI) is a software component used for the installation,maintenance, and removal of software on Microsoft Windows systems.
In the Process Editor Available Plugin Steps, navigate to Installers > MSI.
This plugin has the following steps for you to add to your processes:
• Install MSI
• Uninstall MSI
• Execute msiexec
For information about MSI, see http://support.microsoft.com/kb/310598.
Plugins Guide 437
Part 10: System Tools and Scripting Plugins
438 Deployment Automation
Chapter 70: MS Windows PowerShellPlugin
Windows PowerShell is a task automation and configuration management framework fromMicrosoft, consisting of a command-line shell and associated scripting language.
The PowerShell plugin provides a step for executing user-defined PowerShell scripts.
In the Process Editor Available Plugin Steps, navigate to Scripting > PowerShell.
This plugin has the following steps for you to add to your processes:
• Creating a Run a PowerShell Script Step [page 439]
For information about Windows PowerShell, see http://technet.microsoft.com/en-us/scriptcenter/powershell.aspx.
Creating a Run a PowerShell Script StepThis step executes a PowerShell script.
You can pass two user-provided parameters to the script, the path to inputPropFile andthe path to outputPropFile. This enables the script to read and write values to those filesthat can be used later on, for example in next process step.
In the following example, the PowerShell plugin gets the first three lines frominputPropsFile and writes them to outputPropFile using the parameters args[0] andargs[1].
#get 3 lines from inputPropsFile#$InputProps = get-content $($args[0]) | select -first 3Write-Host "InputProps"$InputProps
#set 3 lines from outputPropsFile#set-content $($args[1]) $InputProps$OutputProps = get-content $($args[1])
Write-Host "OutputProps"$OutputProps
Plugins Guide 439
Required properties:
PropertyName
Description
Script Enter the script code to execute. A Java properties file for outputproperties to upload to the server can be accessed using args[0] andanother containing all the input properties can be accessed using args[1].
PowerShellCommandPath
The absolute path to the PowerShell executable. Leave it blank if it's onthe path.
Optional properties: None
Part 10: System Tools and Scripting Plugins
440 Deployment Automation
Chapter 71: MS Windows Service ControlManager Plugin
Microsoft Windows Service Control Manager stores information about the installed servicesand their status. It can start and stop services, transmit control requests to runningservices, and lock and unlock the service database.
The Service Control Manager plugin is used during the deployment to automate Windowsservices.
In the Process Editor Available Plugin Steps, navigate to System Utility > Windows >ServiceControlManager.
This plugin has the following steps for you to add to your processes:
• Create Service
• Delete Service
• Start Service
• Stop Service
• Check If Service Exists
• Check If Service Stopped
• Check If Service Running
• Enable Service
• Disable Service
For information about Windows Service Control Manager, see http://msdn.microsoft.com/en-us/library/d56de412(v=vs.80).aspx.
Plugins Guide 441
Part 10: System Tools and Scripting Plugins
442 Deployment Automation
Chapter 72: MS Windows System ToolsPlugin
The Microsoft Windows System Tools plugin automates various Windows system tasks.
In the Process Editor Available Plugin Steps, navigate to System Utility > Windows >WindowsSystemTools.
This plugin has the following steps for you to add to your processes:
• Creating a Modify ACLs Step [page 443]
• Creating a Log off Notification Step [page 445]
• Creating a Reboot Step [page 446]
• Creating a Check File Contents Step [page 446]
• Creating an Add or Overwrite Registry Step [page 446]
• Creating an Export Registry Subkey to File Step [page 447]
• Creating an Import Registry Files Step [page 448]
• Creating a Configure DCOM Settings Step [page 448]
• Creating a Create Message Queues Step [page 449]
• Creating an Enable Windows Features Step [page 450]
• Creating a Disable Windows Features Step [page 450]
• Creating a Create Windows Event Log Step [page 451]
Creating a Modify ACLs StepThis step assigns access control lists (ACLs) to files or folders.
Required properties:
PropertyName
Description
DirectoryOffset
The working directory to use when executing this command. This isrelative to current working directory. Default value: .
CACLSType
Select whether to use CACLS, XACLS, or ICACLS to modify permissions.
File filter A file filter to limit the files/folders to modify. Default value: .
Plugins Guide 443
Optional properties:
PropertyName
Description
CACLS Path The path to the (X)CACLS executable. For example:C:\Windows\System32
Includesubdirectories
Check this option to change ACLs of specified files in the currentdirectory and all subdirectories.
Edit ACLsinstead ofreplacing
Check this option to edit ACL instead of replacing it. This option cannotbe used with ICACLS.
Continue onaccess deniederrors
Check this option to continue on access denied errors.
Grant UserAccess Rights
A list of new-line separated permissions in the format ofuser:perm;spec, where perm can be:
• R: Read
• C: Change (write)
• F: Full control
• P: Change permissions (special access)
• T: Take ownership (special access)
• X: Execute (special access)
• E: Read (special access)
• W: Write (special access)
• D: Delete (special access)
Revoke user'srights
Revoke specified user's access rights (only valid with Edit ACLsinstead of replacing option unless using ICACLS).
Part 10: System Tools and Scripting Plugins
444 Deployment Automation
PropertyName
Description
ReplaceUser's AccessRights
A list of new-line separated permissions in the format ofuser:perm;spec, where perm can be:
• R: Read
• C: Change (write)
• F: Full control
• P: Change permissions (special access)
• T: Take ownership (special access)
• X: Execute (special access)
• E: Read (special access)
• W: Write (special access)
• D: Delete (special access)
Deny useraccess
Deny specified user access. If using XCACLS or CACLS, specify theuser. With ICACLS, this denies specified rights to the user, requiringthe format of user:perm.
Replacewithout verify
Replace user's rights without verify. Only valid with XCACLS.
Creating a Log off Notification StepThis step sends a message to logged on users to log off.
Required properties:
Property Name Description
Message Text Specify the message that will be displayed to uses logged onto the server.
Windows ServerVersion
Select the server version the plugin will run on, 2003 or 2008.
Number of Times toRetry
This determines the amount of times the plugin will check forlogged on users before failing the deploy.
Wait Time BetweenRetries(Seconds)
This specifies the amount of time to wait between retries.
Plugins Guide 445
Optional properties:
Property Name Description
Server to Query This specifies the server to query active sessions.
Creating a Reboot StepThis step reboots the operating system.
Required properties:
Property Name Description
Time The time in seconds to wait to reboot.
Creating a Check File Contents StepThis step checks the file contents against a regular expression.
Required properties:
Property Name Description
File to scan The name of the file to scan.
Regular Expression The regular expression used to scan the file contents.
Optional properties:
PropertyName
Description
DirectoryOffset
The working directory to use when executing this command. This isrelative to current working directory.
Fail if a matchwas found
Check this option to fail the step if a match was found. Default is tofail if a match is not found.
Creating an Add or Overwrite Registry StepThis step adds or overwrites a key to the registry.
Required properties:
Property Name Description
Registry Key Specify the registry key. For example: HKLM\Software\MyCo
Part 10: System Tools and Scripting Plugins
446 Deployment Automation
Property Name Description
Windows Server Version Select the server version the plugin will run on. Values are:
• REG_S
• REG_MUTLI_SZ
• REG_BINARY
• REG_DWORD_BIG_ENDIAN
• REG_DWORD
• REG_DWORD_LITTLE_ENDIAN
• REG_NONE
• REG_EXPAND_SZ
Registry Value Name Specify the registry value name.
Registry Value Data Specifies the registry value data.
Optional properties:
Property Name Description
Force Registry Overwrite This will overwrite the existing registry key.
Creating an Export Registry Subkey to File StepThis step exports a registry subkey to a file.
Required properties:
PropertyName
Description
RegistryKey
Specify the registry key to export. For example: HKLM\Software\MyCo
DestinationFile
Specify the destination file for export. For example: example.reg, c:/path/to/example.reg
Plugins Guide 447
Optional properties:
Property Name Description
Force FileOverwrite
When enabled, this step will overwrite the destination file if itexists.
Creating an Import Registry Files StepThis step imports a file containing registry keys.
Required properties:
PropertyName
Description
SourceDirectory
Specify the source directory. Default value: .
IncludeFiles
Enter a new-line separated set of file filters to import into the registry.Default value: **/*.reg
Optional properties:
PropertyName
Description
Exclude Files Enter a new-line separated set of file filters for the files to excludefrom the execution.
Creating a Configure DCOM Settings StepThis step configures DCOM settings.
Part 10: System Tools and Scripting Plugins
448 Deployment Automation
Required properties:
Property Name Description
Authentication Level Select the DCOM authentication level. Values are:
• None
• Connect
• Call
• Packet
• Packet Integrity
• Packet Privacy
Impersonate Level Select the DCOM impersonate level. Values are:
• Anonymous
• Identify
• Impersonate
• Delegate
Optional properties:
Property Name Description
Enable Remote DCOM This will enable remote DCOM.
Creating a Create Message Queues StepThis step creates message queues.
Optional properties:
PropertyName
Description
Non-TransactionalQueues
A new-line separated list of non-transactional message queues tocreate. For example: .\newQueue1 or .\Private$\newPrivateQueue1
TransactionalQueues
A new-line separated list of transactional message queues to create.For example: .\newQueue1 or .\Private$\newPrivateQueue1
Plugins Guide 449
Creating an Enable Windows Features StepThis step enables specific Windows features. This works only with Windows 7.
Required properties:
PropertyName
Description
Features A comma and/or new-line separated list of features to enable. Do notinclude /featurename:
Optional properties:
Property Name Description
Directory Offset Specify a subdirectory of the current working directory where youwant the command to execute.
Dism executablelocation
The path to the DISM executable.
AdditionalOptions
A comma or new-line separated list of additional options to besupplied to the DISM command.
Creating a Disable Windows Features StepThis step disables specific Windows features. This works only with Windows 7.
Required properties:
PropertyName
Description
Features A comma and/or new-line separated list of features to disable. Do notinclude /featurename:
Optional properties:
Property Name Description
Directory Offset Specify a subdirectory of the current working directory where youwant the command to execute.
Dism executablelocation
The path to the DISM executable.
AdditionalOptions
A comma or new-line separated list of additional options to besupplied to the DISM command.
Part 10: System Tools and Scripting Plugins
450 Deployment Automation
Creating a Create Windows Event Log StepThis step creates a new event log and a new event source.
Required properties:
PropertyName
Description
LogName
The name of the event log.
Sources A comma-separated list of the names of the event log sources, such asapplication programs that write to the event log.
Optional properties:
PropertyName
Description
CategoryResourceFile
Specifies the path to the file that contains category strings for thesource events. This file is also known as the Category Message File.
MessageResourceFile
Specifies the path to the file that contains message formatting stringsfor the source events. This file is also known as the Event Message File.
ParameterResourceFile
Specifies the path to the file that contains strings used for parametersubstitutions in event descriptions. This file is also known as theParameter Message File.
Powershellexecutablelocation
The path to the Powershell executable.
Plugins Guide 451
Part 10: System Tools and Scripting Plugins
452 Deployment Automation
Chapter 73: Red Hat Package Manager(RPM) Plugin
The Red Hat Package Manager (RPM) is an open packaging system that runs on Red HatEnterprise Linux and other Linux and UNIX systems.
In the Process Editor Available Plugin Steps, navigate to Installers > RPM.
This plugin has the following steps for you to add to your processes:
• Creating an Install RPM Step [page 453]
• Creating an Uninstall RPM Step [page 453]
• Creating an Update RPM Step [page 454]
For information about Red Hat Package Manager (RPM), see http://www.rpm.org/.
Creating an Install RPM StepYou may use this step to install RPM packages.
To create an install RPM step:
1. Enter the Name for your install RPM step.
2. Use the RPM Packages field to list the RPM packages you want this step to install.
Important: Packages must each be listed on a new line separated fromthe next.
3. (Optional) You may choose to specify the following: Install Options (also in anew-line separated list) to be used during the install.
Creating an Uninstall RPM StepYou may use this step to uninstall RPM packages.
To create an uninstall RPM step:
1. Enter the Name for your uninstall RPM step.
2. Use the RPM Packages field to list the RPM packages you want this step to uninstall.
Important: Packages must each be listed on a new line separated fromthe next.
3. (Optional) You may choose to specify the following: Erase Options (also as a new-line separated list) to be used during the uninstall.
Plugins Guide 453
Creating an Update RPM StepYou may use this step to update RPM packages.
To create an update RPM step:
1. Enter the Name for your update RPM step.
2. Use the RPM Packages field to list the RPM packages you want this step to install.
Important: Packages must each be listed on a new line separated fromthe next.
3. (Optional) You may choose to specify the following: Update Options (also in a new-line separated list) to be used during the install.
Part 10: System Tools and Scripting Plugins
454 Deployment Automation
Chapter 74: Shell Plugin
A shell is a command language interpreter that is usually included with operating systems.A shell script is a series of commands.
The Shell plugin enables you to run custom shell scripts during the deployment process.The most common use case for this plugin is opening and running a shell script on thetarget machine. If the step is used within a larger process, ensure that you set the ordercorrectly. For example, if you have to run a shell script prior to executing another process,you will need to add the Shell step above the other step.
Note: This plugin is included in the standard plugins provided with DeploymentAutomation and need not be loaded unless you need to upgrade or extend it.
In the Process Editor Available Plugin Steps, navigate to Scripting > Shell.
This plugin has the following steps for you to add to your processes:
• Creating a Run a Shell Script Step [page 455]
• Creating a Run a Shell Script with X Arguments Step [page 456]
Creating a Run a Shell Script StepThis step executes a shell or batch script.
Required properties:
PropertyName
Description
DirectoryOffset
The working directory to use when executing this command. This isrelative to the current working directory.
ShellScript
Enter the script code to execute.
Optional properties:
PropertyName
Description
Interpreter Optionally specify the interpreter to use to evaluate the command. If leftblank the following platform-specific behavior will be used: CommandLine will use the .bat file interpreter on Windows and the .com fileinterpreter on VMS. On other systems it will use the shell specified by theair/shell agent variable if present. UNIX/Linux systems may override thisby having the command line start with a #! sequence.
Plugins Guide 455
PropertyName
Description
Daemon Select this option to run the command in the background whilepermitting the step to complete immediately. The output will not becaptured if running as a daemon.
OutputFile
Only select this value if running as a daemon. Enter the path of the file towhich the command output is directed. Leave blank to discard the output.The output will not be captured if an output file is not specified.
Creating a Run a Shell Script with X Arguments StepThis step executes a shell or batch script a number of times equal to a multi-valued input.
Required properties:
PropertyName
Description
DirectoryOffset
The working directory to use when executing this command. This isrelative to the current working directory.
xargs The comma-separated values to use as input to the script. They arepassed as input to the script.
ShellScript
Enter the script code to execute.
Optional properties:
PropertyName
Description
Interpreter Optionally specify the interpreter to use to evaluate the command. If leftblank the following platform-specific behavior will be used: CommandLine will use the .bat file interpreter on Windows and the .com fileinterpreter on VMS. On other systems it will use the shell specified by theair/shell agent variable if present. UNIX/Linux systems may override thisby having the command line start with a #! sequence.
Daemon Select this option to run the command in the background whilepermitting the step to complete immediately. The output will not becaptured if running as a daemon.
OutputFile
Only select this value if running as a daemon. Enter the path of the file towhich the command output is directed. Leave blank to discard the output.The output will not be captured if an output file is not specified.
Part 10: System Tools and Scripting Plugins
456 Deployment Automation
Chapter 75: System Information Plugin
The System Information plugin includes a variety of checks to perform against theoperating system. You can use this plugin to verify that a deployment can succeed or hassucceeded.
In the Process Editor Available Plugin Steps, navigate to System Utility > SystemInformation.
This plugin has the following steps for you to add to your processes:
• Check Connectivity
• Check Environment Variable
• Check Available Disk Space
• Check Regex
Plugins Guide 457
Part 10: System Tools and Scripting Plugins
458 Deployment Automation
Part 11: Virtual and Cloud EnvironmentManagement Plugins
This section contains the following information:
• Chapter 76: Amazon EC2 Plugin [page 461]
• Chapter 77: AWS CloudFormation Plugin [page 467]
• Chapter 78: Microsoft Windows Azure Plugin [page 471]
• Chapter 79: VMware vSphere ESXi Plugin [page 473]
• Chapter 80: VMware vCenter Plugin [page 475]
• Chapter 81: VMware Workstation Plugin [page 477]
Plugins Guide 459
Part 11: Virtual and Cloud Environment Management Plugins
460 Deployment Automation
Chapter 76: Amazon EC2 Plugin
Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides environmentsupport in the cloud.
In the Process Editor Available Plugin Steps, navigate to Cloud > AmazonEC2.
This plugin has the following steps for you to add to your processes:
• Creating an Amazon EC2 Launch Instance Step [page 461]
• Creating an Amazon EC2 Security Group Step [page 462]
• Creating Amazon EC2 Start, Stop, and Terminate Instance Steps [page 463]
• Creating an Amazon EC2 Wait for Instance Step [page 464]
• Creating an Amazon EC2 Associate IPs Step [page 464]
• Creating an Amazon EC2 Register Instances with LoadBalance Step [page 465]
• Creating an Amazon EC2 Deregister Instances with LoadBalance Step [page 466]
• Creating an Amazon EC2 Get Public DNS Step [page 466]
For information about Amazon EC2, see https://aws.amazon.com/ec2/.
Creating an Amazon EC2 Launch Instance StepThe basic building blocks of Amazon EC2 are the Amazon Machine Images (AMI). An AMIis a template that contains a software configuration, such as an operating system,application server, or applications that you can run in an Amazon environment. Amazonhas a variety of AMIs available and you can also create you own.
To launch an instance from AMI, you need to create an Amazon EC2 Launch Instancestep.
To create an Amazon EC2 launch instance step:
1. Enter a Name for your Launch Instance step.
2. Specify values for the following required properties:
Property Description
AccessKey Id
The EC2 access key ID to use to log in.
SecretKey
The EC2 secret key.
Plugins Guide 461
Property Description
# ofinstances
The number of EC2 instances to startup.
InstanceType
The type of instances to run. Allowed values are m1.small, m1.large,m1.xlarge, m2.xlarge, m2.4xlarge, c1.medium, c1.xlarge.
AMI ID The AMI ID of the instances to be started.
AWS Jar The full path to the AWS SDK .jar file.
3. You may choose to specify values for the following optional properties:
Property Description
Security Group A comma-separated list of security group names to use.
Availability Zone The zone to start these instances in.
Keypair The keypair to start these instances with.
User data The user data to be passed to the instance.
Creating an Amazon EC2 Security Group StepThe Amazon EC2 security group acts as a firewall that controls the traffic allowed into agroup of instances.
To create a security group step:
1. Enter a Name for your Security Group step.
2. Specify values for the following required properties:
Property Description
Access Key Id The EC2 access key ID to use to log in.
Secret Key The EC2 secret key.
AWS Jar The full path to the AWS SDK .jar file.
3. You may choose to specify values for the following optional properties:
Part 11: Virtual and Cloud Environment Management Plugins
462 Deployment Automation
Property Description
Name The name of the security group to create, if not using a file to addpermissions.
Description The description of the security group to create, if not using a file toadd permissions.
VPC ID The ID of the Virtual Private Cloud (VPC) to use, if not using a fileto add permissions.
DefinitionFile
The file describing the security group allowed ips/ports.
If left blank, an empty security group will be created.
Otherwise, the file has the following format:
<SecurityGroup name="name" description="description"vpcId="id_optional"> <ipPermission protocol="tcp" fromPort="nn"toPort="nn">
<ipRange value="0.0.0.0/0"/>
</ipPermission>
</SecurityGroup>
Creating Amazon EC2 Start, Stop, and TerminateInstance StepsTo start, stop, or terminate an Amazon EC2 instance, you pass the same set ofparameters. These give the information needed to identify the instance that you want tostart, stop, or terminate. The only difference is start and stop steps accept only oneInstance ID whereas the terminate step accepts more than one instance ID.
To create a start, stop, or terminate instance step:
1. Enter a Name for your start, stop, or terminate instance step.
2. Specify values for the following required properties:
Property Description
AccessKey Id
The EC2 access key ID to use to log in.
SecretKey
The EC2 secret key.
instanceID
The Instance ID to start or stop, or for the terminate step, a list ofinstance IDs separated by commas.
Plugins Guide 463
Property Description
AWS Jar The full path to the AWS SDK .jar file.
Creating an Amazon EC2 Wait for Instance StepUse to create a step that waits until the instance(s) specified in the Instance IDs fieldswitch to the state specified in the State field.
To create a Wait for Instance step:
1. Enter a Name for your Wait for Instance step.
2. Specify values for the following required properties:
Property Description
Access KeyId
The EC2 access key ID to use to log in.
Secret Key The EC2 secret key.
InstanceIDS
A comma-separated list of instance IDs that correspond to the IPsto associate.
State The state for instances to be in.
Timeout The timeout for this step, in milliseconds.
AWS Jar The full path to the AWS SDK .jar file.
Creating an Amazon EC2 Associate IPs StepIn an AWS, an Elastic IP Address (EIP) enables you to reserve an IP address that you canthen assign to any AMI instance you have running. If needed, at any time you can alsochange the assignment to a different instance.
According to Amazon, this feature is designed for "dynamic cloud computing". Once anEIP has been associated with an instance, it remains associated with that instance untilyou release it.
To create an associate IPs step:
1. Enter a Name for your Associate IPs step.
2. Specify values for the following required properties:
Part 11: Virtual and Cloud Environment Management Plugins
464 Deployment Automation
Property Description
Access KeyId
The EC2 access key ID to use to log in.
Secret Key The EC2 secret key.
IPS A new-line separated list of elastic ips to associate with instances.
InstanceIDS
A comma-separated list of instance IDs that correspond to the IPsto associate.
AWS Jar The full path to the AWS SDK .jar file.
Creating an Amazon EC2 Register Instances withLoadBalance StepElastic Load Balancing automatically distributes incoming application traffic across multipleAmazon EC2 instances. It enables you to achieve even greater fault tolerance in yourapplications, seamlessly providing the amount of load balancing capacity needed inresponse to incoming application traffic. Elastic Load Balancing detects unhealthyinstances within a pool and automatically reroutes traffic to healthy instances until theunhealthy instances have been restored.
You can enable Elastic Load Balancing within a single Availability Zone or across multiplezones for even more consistent application performance. Elastic Load Balancing can alsobe used in an Amazon Virtual Private Cloud (VPC) to distribute traffic between applicationtiers. For more details, see the Amazon Elastic Compute Cloud documentation.
To create an Amazon EC2 Register Instance with LoadBalance Step:
1. Enter a Name for your Register Instance with LoadBalance step.
2. Specify values for the following required properties:
Property Description
Access Key Id The EC2 access key ID to use to log in.
Secret Key The EC2 secret key.
Load BalancerName
The name of the load balancer in this EC2 account to registerthe instances from.
Instance Ids Instance ID to start.
AWS Jar The full path to the AWS SDK .jar file.
Plugins Guide 465
Creating an Amazon EC2 Deregister Instances withLoadBalance StepThe Deregister Instances With LoadBalancer works the same as the re-registration exceptthat you have to use another step for it.
To create an Amazon EC2 Deregister Instance with LoadBalance Step:
1. Enter a Name for your Register Instance with LoadBalance step.
2. Specify values for the following required properties:
Property Description
Access Key Id The EC2 access key ID to use to log in.
Secret Key The EC2 secret key.
Load BalancerName
The name of the load balancer in this EC2 account to de-register the instances from.
Instance Ids Instance ID to start.
AWS Jar The full path to the AWS SDK .jar file.
Creating an Amazon EC2 Get Public DNS StepYou may get the list of public DNSs that a list of Amazon EC2 instances are running on.
To create an Amazon EC2 Get Public DNS Step:
1. Enter a Name for your Get Public DNS step.
2. Specify values for the following required properties:
Property Description
AccessKey Id
The EC2 access key ID to use to log in.
SecretKey
The EC2 secret key.
InstanceIds
A comma-separated list of instance IDs to be retrieved. The DNS listreturned will be in the same order as the IDs given.
AWS Jar The full path to the AWS SDK .jar file.
Part 11: Virtual and Cloud Environment Management Plugins
466 Deployment Automation
Chapter 77: AWS CloudFormation Plugin
AWS CloudFormation lets you create and manage a collection of related Amazon WebServices (AWS) resources.
With the AWS CloudFormation plugin you can use existing templates with dynamicruntime values for the chosen service or application architectures and provision theservices or applications. You can modify the template values as desired.
In the Process Editor Available Plugin Steps, navigate to Cloud > CloudFormation.
This plugin has the following steps for you to add to your processes:
• Creating an AWS CloudFormation List Stack Step [page 467]
• Creating an AWS CloudFormation Modify Stack Step [page 468]
• Creating an AWS CloudFormation Update Stack Step [page 468]
For information about AWS CloudFormation, see https://aws.amazon.com/cloudformation/.
Creating an AWS CloudFormation List Stack StepThis step enables you to select a stack from the stack list. This should typically be the firstAWS CloudFormation plugin step in your process, as it is used to get information passedto subsequent steps.
Required properties:
Property Description
Access Key The CloudFormation access key for login
Secret Key The CloudFormation secret key for login
Region Select the region that contains the stack you want.
Optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Plugins Guide 467
Creating an AWS CloudFormation Modify Stack StepThis step enables you to view and edit a selected stack template. The List Stack stepshould typically be just before this step in the process.
Note: The following properties are used to get the template body from AWSCloudFormation. Once the plugin gets the template body, it will display thedynamic fields using the Deployment Automation standard user interface (UI)elements converted and sent from the Deployment Automation agent. The UIwill be rendered dynamically in a multi-edit form, which can be edited by theuser and resubmitted for further processing.
Required properties:
Property Description
Access Key The CloudFormation accesskey for login
Secret Key The CloudFormation secretkey for login
Stack Name The stack name can bepassed from a previous"List Stack" step or youcan enter a stack name.
Region Select the region thatcontains the stack youwant.
Optional properties:
PropertyName
Description
DisplayResultsSelectionDialog
Controls whether the information returned from this step is displayed in adialog box upon successful execution of the containing process, enablingyou to select specific information to be used in subsequent process steps.This is set to true by default, and is implicitly required, because without it,there is no way to select the information.
Creating an AWS CloudFormation Update Stack StepThis step enables you to submit the changed stack to the AWS CloudFormation. TheModify Stack step should typically be just before this step in the process.
Part 11: Virtual and Cloud Environment Management Plugins
468 Deployment Automation
Required properties:
Property Description
Access Key The CloudFormation accesskey for login
Secret Key The CloudFormation secretkey for login
Stack Name The stack name can bepassed from a previous"List Stack" step or youcan enter a stack name.
Region Select the region thatcontains the stack youwant.
Modified Values The modified templatevalues for the stack
Original Template The original templatecontent is passed from aprevious Modify Stackstep and will be used forsubmitting the modifiedvalues to AWSCloudFormation.
Optional properties: None.
Plugins Guide 469
Part 11: Virtual and Cloud Environment Management Plugins
470 Deployment Automation
Chapter 78: Microsoft Windows AzurePlugin
Microsoft Windows Azure is an open cloud platform that enables you to build, deploy, andmanage applications across a global network of Microsoft-managed datacenters.
The Azure plugin provides steps for working with Microsoft Azure cloud instances.
In the Process Editor Available Plugin Steps, navigate to Cloud > Azure.
This plugin has the following steps for you to add to your processes:
• Add Endpoint
• Create VM
• Delete VM
• Restart VM
• Start VM
• Stop VM
For information about Azure, see http://www.windowsazure.com.
Plugins Guide 471
Part 11: Virtual and Cloud Environment Management Plugins
472 Deployment Automation
Chapter 79: VMware vSphere ESXi Plugin
VMware vSphere installs directly on top of a physical server and partitions it into multiplevirtual machines that can run simultaneously, sharing the physical resources of theunderlying server.
The VMware ESXi plugin provides steps for working with VMware vSphere ESX and ESXivirtual machines.
In the Process Editor Available Plugin Steps, navigate to Virtualization > VMware >ESXi.
This plugin has the following steps for you to add to your processes:
• Delete Snapshot
• Start VM
• Stop VM
• Suspend VM
• Take Snapshot
• Revert VM to Snapshot
• VM settings
For information about VMware vSphere ESX and ESXi, see http://www.vmware.com/products/vsphere/esxi-and-esx/overview.html.
Plugins Guide 473
Part 11: Virtual and Cloud Environment Management Plugins
474 Deployment Automation
Chapter 80: VMware vCenter Plugin
VMware vCenter Server provides centralized management of VMware virtual machinesfrom a single console.
The VMware vCenter plugin provides steps for working with virtual machines defined inVMware vCenter.
In the Process Editor Available Plugin Steps, navigate to Virtualization > VMware >vCenter.
This plugin has the following steps for you to add to your processes:
• Clone VM
• Delete Snapshot
• Start VM
• Stop VM
• Suspend VM
• Take Snapshot
• Revert VM to Snapshot
• VM settings
For information about VMware vCenter, see http://www.vmware.com/products/vcenter-server/overview.html.
Plugins Guide 475
Part 11: Virtual and Cloud Environment Management Plugins
476 Deployment Automation
Chapter 81: VMware Workstation Plugin
VMware Workstation enables you to access virtual machines running on VMware vSphere,ESXi, or another copy of VMware Workstation.
The VMware Workstation plugin provides steps for working with VMware Workstationvirtual machines.
In the Process Editor Available Plugin Steps, navigate to Virtualization > VMware >Workstation.
This plugin has the following steps for you to add to your processes:
• Creating a Clone VM Step [page 477]
• Creating a Delete Snapshot Step [page 479]
• Creating a Revert to Snapshot Step [page 479]
• Creating a Start VM Step [page 479]
• Creating a Stop VM Step [page 480]
• Creating a Suspend VM Step [page 480]
• Creating a Take Snapshot Step [page 480]
For information about VMware Workstation, see http://www.vmware.com/products/workstation/overview.html.
Creating a Clone VM StepThe Clone VM step clones a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
Sourcepath andfile name
Please specify the full path, including file name, for the source .vmx file.
Plugins Guide 477
Optional properties:
Property Description
Snapshotname
If the snapshot name is included, the clone will be created from thespecified snapshot.
CreateLinkedClone
Creates the clone so that it shares virtual disks with the parent virtualmachine in an ongoing manner. This conserves disk space as long as theparent and clone do not change very much from their original state.
Part 11: Virtual and Cloud Environment Management Plugins
478 Deployment Automation
Creating a Delete Snapshot StepThe Delete Snapshot step deletes a snapshot of a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, for the source .vmx file.
Snapshotname
The snapshot name or the path to the snapshot in the tree, for multiplesnapshots with the same name. For example, /snap1/snap1.1/snap1.1.2
Optional properties: None
Creating a Revert to Snapshot StepThe Revert to Snapshot step reverts to a snapshot of the virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, for the source .vmx file.
Snapshotname
The snapshot name or the path to the snapshot in the tree, for multiplesnapshots with the same name. For example, /snap1/snap1.1/snap1.1.2
Optional properties: None
Creating a Start VM StepThe Start VM step starts a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
Plugins Guide 479
Property Description
VM path Specify the full path, including file name, for the source .vmx file.
Optional properties: None
Creating a Stop VM StepThe Stop VM step stops a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, for the source .vmx file.
Optional properties: None
Creating a Suspend VM StepThe Suspend VM step suspends a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, for the source .vmx file.
Optional properties: None
Creating a Take Snapshot StepThe Take Snapshot step takes a snapshot of a virtual machine.
Required properties:
Property Description
Full pathto vmrunutility
Specify the full path, including file name, to the tool that is used toexecute VMware commands. For example, C:\Program Files(x86)\VMware\VMware Workstation\vmrun.exe
Part 11: Virtual and Cloud Environment Management Plugins
480 Deployment Automation
Property Description
VM path Specify the full path, including file name, for the source .vmx file.
Snapshotname
Specify the snapshot name.
Optional properties: None
Plugins Guide 481