help.serena.com€¦ · actions reference guide 3 contents preface...

SERENA® RELEASE AUTOMATION 3.3

Powered by Nolio

Actions Reference Guide Serena Proprietary and Confidential Information

Copyright © 2012 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 only in accordance with the terms of such license. Except as permitted by such license, no part of this publication may 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 reproduction of such software product user documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification.

This document contains proprietary and confidential information, and no reproduction or dissemination of any information contained 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, and should not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errors or inaccuracies that may appear in this document.

Trademarks

Serena, StarTool, PVCS, Comparex, Dimensions, Mashup Composer, Prototype Composer, and ChangeMan are registered trademarks of Serena Software, Inc. The Serena logo and Meritage are trademarks of Serena Software, Inc. All other products or company names are used for identification purposes only, and may be trademarks of their respective owners.

U.S. Government Rights

Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, its agencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosure by the U.S. Government is subject to the restrictions set forth in the license under which the Software was acquired. The manufacturer is Serena Software, Inc., 1900 Seaport Boulevard, 2nd Floor, Redwood City, California 94063-5587.

Actions Reference Guide 3

Contents Preface ......................................................................................................................... 17

About this Document ....................................................................................................17 Intended Audience .......................................................................................................17 Related Documentation ................................................................................................17 Technical Support ........................................................................................................17

Introduction ................................................................................................................. 19

Using the Actions Reference Guide .................................................................................19 Understanding Reference Terms ....................................................................................19

Amazon EC2 Actions ..................................................................................................... 21

AMI Actions .................................................................................................................21 EC2 - Create Image.................................................................................................21 EC2 - Deregister Image ...........................................................................................23 EC2 - Get Image Information ...................................................................................24 EC2 - Register Instance ...........................................................................................26

EC2 - Register Image ...................................................................................................27 EC2 - Start Existing AMI ..........................................................................................28

Bundle Tasks Actions....................................................................................................30 EC2 - Bundle Instance .............................................................................................30 EC2 - Cancel Bundle Task ........................................................................................32 EC2 - Get Bundle Task Information ...........................................................................34

Elastic IP Actions .........................................................................................................36 EC2 - Allocate Address .............................................................................................36 EC2 - Associate Address ..........................................................................................37 EC2 - Disassociate Address ......................................................................................38 EC2 - Get Address Instance ......................................................................................39 EC2 - List All Addresses ...........................................................................................40 EC2 - Release Address .............................................................................................41

Instance Actions ..........................................................................................................42 EC2 - Disable Monitoring on Running Instances ..........................................................42 EC2 - Get Console Output ........................................................................................43 EC2 - Get Instance Information ................................................................................44 EC2 - Get Password .................................................................................................46 EC2 - List All Instances ............................................................................................47 EC2 - Modify Instance Attributes ...............................................................................48 EC2 - Monitor Instance ............................................................................................50 EC2 - Reboot Instance .............................................................................................51

Contents

4 Serena® Release Automation 3.3

EC2 - Run Instance .................................................................................................52 EC2 - Start Instance ................................................................................................54 EC2 - Stop Instance ................................................................................................55 EC2 - Terminate Instance ........................................................................................56

Key Pair Actions...........................................................................................................57 EC2 - Create Key Pair ..............................................................................................57 EC2 - Delete Key Pair ..............................................................................................58 EC2 - List All Key Pairs ............................................................................................59

Load Balancer Actions ..................................................................................................60 EC2 - Configure Health Check ...................................................................................60 EC2 - Create LoadBalancer .......................................................................................62 EC2 - Delete LoadBalancer .......................................................................................64 EC2 - Disable Availability Zones for LoadBalancer .......................................................65 EC2 - Enable Availability Zones for LoadBalancer ........................................................66 EC2 - Get Availability Zone Information .....................................................................67 EC2 - Get Health Check for Load Balancer ..................................................................68 EC2 - List All Availability Zones .................................................................................70 EC2 - List All LoadBalancers .....................................................................................71 EC2 - List Availability Zones in Load Balancer .............................................................72 EC2 - List Instances in Load Balancer ........................................................................73 EC2 - Register Instance ...........................................................................................74 EC2 - Unregister Instance ........................................................................................75

Security Group Actions .................................................................................................76 EC2 - Add Permissions to Security Group ...................................................................76 EC2 - Create Security Group.....................................................................................78 EC2 - Delete Security Group .....................................................................................79 EC2 - List All Security Groups ...................................................................................80 EC2 - List Security Group Permissions .......................................................................81 EC2 - Remove Permissions from Security Group .........................................................83

Snapshot Actions .........................................................................................................85 EC2 - Create Snapshot ............................................................................................85 EC2 - Delete Snapshot .............................................................................................86 EC2 - Get Snapshot Information ...............................................................................87 EC2 - List All Snapshots ...........................................................................................89

Volume Actions............................................................................................................90 EC2 - Attach Volume ...............................................................................................90 EC2 - Create Volume ...............................................................................................91 EC2 - Delete Volume ...............................................................................................92 EC2 - Detach Volume ..............................................................................................93 EC2 - Get Volume Information ..................................................................................94

Contents


EC2 - List All Volumes..............................................................................................96 Application Server Actions ............................................................................................ 97

WebLogic Actions .........................................................................................................97 Configuring for WLS Actions on Serena Agent Machines ...............................................97 WLS - Create Data Source ........................................................................................98 WLS - Delete Application ........................................................................................ 100 WLS - Delete Data Source ...................................................................................... 101 WLS - Deploy Installed Application .......................................................................... 102 WLS - Get Application State ................................................................................... 103 WLS - Get Server(s) State ..................................................................................... 104 WLS - Install New Application ................................................................................. 105 WAS - Create Informix Data Source Action ............................................................... 106 WLS - Resume Server(s) ........................................................................................ 109 WLS - Run WLST Script.......................................................................................... 110 WLS - Shutdown Server(s) ..................................................................................... 111 WLS - Start Application .......................................................................................... 112 WLS - Start Server(s) ............................................................................................ 113 WLS - Stop Application .......................................................................................... 114 WLS - Suspend Server(s) ....................................................................................... 115 WLS - Undeploy Application .................................................................................... 116

WebSphere Actions .................................................................................................... 117 Configuring for WAS Actions on Serena Agent Machines ............................................. 117 WAS - Check Environment Variable Exists ................................................................ 117 WAS - Create/Update Environment Variable ............................................................. 119 WAS - Create Data Source for User Defined JDBC Provider Action ............................... 121 WAS - Create DB2 Data Source Action ..................................................................... 123 WAS - Create Derby Data Source Action .................................................................. 125 WAS - Create JAAS - J2C Authentication Data Entry .................................................. 127 WAS - Create Microsoft SQL Server Data Source Action ............................................. 129 WAS - Create Oracle Data Source Action .................................................................. 131 WAS - Create Sybase Data Source Action ................................................................. 133 WAS - Delete Environment Variable ......................................................................... 135 WAS - Delete JAAS - J2C Authentication Data Entry .................................................. 137 WAS - Get Environment Variable Value .................................................................... 139 WAS - Get Managed Server Status .......................................................................... 141 WAS - Install Application ........................................................................................ 143 WAS - Launch Script.............................................................................................. 145 WAS - Start Application ......................................................................................... 147 WAS - Start Managed Server(s) .............................................................................. 149

Contents


WAS - Start Server(s) ........................................................................................... 151 WAS - Start Standalone Server ............................................................................... 153 WAS - Stop Application .......................................................................................... 154 WAS - Stop Managed Server(s) .............................................................................. 156 WAS - Stop Server(s) ............................................................................................ 158 WAS - Stop Standalone Server ............................................................................... 160 WAS - Uninstall Application .................................................................................... 161 WAS - Update Application ...................................................................................... 162

Comparison Actions .................................................................................................... 165

Compare Two Arrays .................................................................................................. 165 Compare Two Booleans .............................................................................................. 166 Compare Two Dates ................................................................................................... 167 Compare Two File Checksums ..................................................................................... 168 Compare Two Folders ................................................................................................. 169 Compare Two Numbers .............................................................................................. 171 Compare Two Strings ................................................................................................. 172 Compare Two Values .................................................................................................. 173

Control Actions ........................................................................................................... 175

Delay ................................................................................................................... 175 User Input - Stop for Manual Operation ........................................................................ 176 Wait For Manual Restart ............................................................................................. 177

Database Actions ........................................................................................................ 179

Execute SQL Query on IBM DB2 Server ........................................................................ 179 Execute SQL Query on Microsoft(c) SQL Server ............................................................. 182 Execute SQL Query on MySQL ..................................................................................... 184 Execute SQL Query on Oracle(c) Database Server.......................................................... 186 Execute SQL Query on Sybase Database Server ............................................................ 188 Test DSN Connection.................................................................................................. 190

Email Action ............................................................................................................... 191

Send Email ............................................................................................................... 191 F5BigIP Actions .......................................................................................................... 193

F5 - Add Member to Pool ............................................................................................ 193 F5 - Change Pool Member's Settings ............................................................................ 195 F5 - Create Pool......................................................................................................... 197 F5 - Delete Pool ......................................................................................................... 198 F5 - Disable iRule ...................................................................................................... 199 F5 - Disable Member .................................................................................................. 200 F5 - Enable iRule ....................................................................................................... 201 F5 - Enable Member ................................................................................................... 202

Contents


F5 - List All Pool Members ........................................................................................... 203 F5 - List All Pools ....................................................................................................... 204 F5 - Remove Member From Pool .................................................................................. 205

File / Folder Actions ................................................................................................... 207

Add Text to a File ...................................................................................................... 208 Change Mode of File or Folder ..................................................................................... 210 Change Owner of File or Folder .................................................................................... 211 Change Read Only Mode of File or Folder ...................................................................... 212 Check if File or Folder Exists ........................................................................................ 213 Check if Specific User has Permissions on File or Folder .................................................. 214 Compare Two File Checksums ..................................................................................... 215 Compare Two Folders ................................................................................................. 216 Copy File or Folder with Backup ................................................................................... 218 Copy File(s) or Folder(s) ............................................................................................. 219 Copy Single File or Folder ........................................................................................... 220 Create a Symbolic Link ............................................................................................... 221 Create Empty File ...................................................................................................... 222 Create Folder ............................................................................................................ 223 Create ZIP File .......................................................................................................... 224 Delete File ................................................................................................................ 225 Delete File or Folder ................................................................................................... 226 Delete Folder............................................................................................................. 227 Download File (FTP Server/Network Drive) .................................................................... 228 Download File (HTTP) ................................................................................................. 229 Extract Text from a File .............................................................................................. 231 Extract ZIP ............................................................................................................... 232 Find Files or Folders ................................................................................................... 233 Find Text in File ......................................................................................................... 235 Get File (SSH) ........................................................................................................... 237 Get File Checksum ..................................................................................................... 238 Get File Details .......................................................................................................... 239 Get File or Folder from Remote Agent ........................................................................... 240 Get File Properties ..................................................................................................... 242 Get Value from an INI file ........................................................................................... 242 Log to File on Serena Center ....................................................................................... 244 Manipulate INI File ..................................................................................................... 245 Move File or Folder..................................................................................................... 246 Put File or Folder in Remote Agent ............................................................................... 247 Read String Array from Text File .................................................................................. 249

Contents


Read String from Text File .......................................................................................... 250 Rename File or Folder................................................................................................. 251 Replace Text in File .................................................................................................... 252 Replace Text in Multiple Files ....................................................................................... 253 Synchronize Two Folders ............................................................................................ 254 Update Value in Array (String) .................................................................................... 256 Write Array to Text File .............................................................................................. 257 ZIP Many Files ........................................................................................................... 258

Installation Actions .................................................................................................... 259

Check if RPM Package is Installed ................................................................................ 259 Execute JavaScript Code ............................................................................................. 260 Install RPM Package ................................................................................................... 262 Install Windows Service .............................................................................................. 263 Retrieve Installed RPM Package Name by RPM File ......................................................... 264 Run Command Line .................................................................................................... 265 Run InstallAnywhere .................................................................................................. 267 Run InstallAnywhere with Predefined Answer File ........................................................... 269 Run InstallShield with Answer File ................................................................................ 270 Run MSI Installer ....................................................................................................... 271 Uninstall RPM Package ................................................................................................ 272

JMX Action .................................................................................................................. 273

Activate JMX ............................................................................................................. 273 Math Actions ............................................................................................................... 275

Calculate Two Numbers .............................................................................................. 275 Create Random Number ............................................................................................. 276

Network Actions ......................................................................................................... 277

Check Free Ports ....................................................................................................... 277 Disconnect Network Drive ........................................................................................... 279 Get IPs of localhost .................................................................................................... 280 Map Network Drive .................................................................................................... 281 Ping a Device ............................................................................................................ 282 Telnet Session ........................................................................................................... 283

OS Actions .................................................................................................................. 285

Linux/Unix Actions ..................................................................................................... 285 Check if RPM Package is Installed ............................................................................ 285 Check if User has Root Credentials .......................................................................... 286

Get Unix/Linux OS Details ........................................................................................... 287 Install RPM Package .............................................................................................. 288 Retrieve Installed RPM Package Name by RPM File .................................................... 289

Contents


Uninstall RPM Package ........................................................................................... 290 Windows Actions ........................................................................................................ 291

Change Credentials for Windows Service .................................................................. 291 Check if Service Exists ........................................................................................... 292 Check Service Status ............................................................................................. 293 Create a Windows Registry Key .............................................................................. 294 Delete a Windows Service ...................................................................................... 295 Delete Windows Registry Folder .............................................................................. 296 Delete Windows Registry Key ................................................................................. 297

Get Microsoft Windows OS Details ................................................................................ 298 Get Windows Registry Key Value ............................................................................. 299

Get Windows Service Properties................................................................................... 300 INI File Actions ..................................................................................................... 301 Install Windows Service ......................................................................................... 303 Modify MSDTC Settings .......................................................................................... 304 Modify Windows Service Properties.......................................................................... 306 MSMQ Actions ...................................................................................................... 308 Restart Windows Service ........................................................................................ 336 Run MSI Installer .................................................................................................. 337 Run Windows Process ............................................................................................ 338 Start Windows Service ........................................................................................... 340 Stop Windows Service ........................................................................................... 341 Update Environment Variable ................................................................................. 342 Update Windows Registry Key ................................................................................ 343

Check OS Type .......................................................................................................... 344 Get Environment Variable Value .................................................................................. 345 Get Java System Property ........................................................................................... 346

Parameter Actions ...................................................................................................... 347

Add a Value to an Array .............................................................................................. 347 Convert String to Number ........................................................................................... 349 Extract Column from ResultSet .................................................................................... 350 Extract Value From an Array ....................................................................................... 351 Extract Value from ResultSet ....................................................................................... 352 Get Array Length ....................................................................................................... 353 Get Index of a Value in an Array .................................................................................. 354 Remove Value from an Array ....................................................................................... 355 Set Parameter Value - Boolean .................................................................................... 356 Set Parameter Value - Integer ..................................................................................... 357 Set Parameter Value - String ....................................................................................... 358

Contents


User Input - Ask For Parameter Value .......................................................................... 359 User Input - Choose from Available Options .................................................................. 360

Performance Counter Actions ..................................................................................... 361

Check if Performance Log Exists .................................................................................. 361 Create Performance Log ............................................................................................. 362 Delete Performance Log .............................................................................................. 363 Get Performance Counter Value ................................................................................... 364 Get Performance Counter Values ................................................................................. 365 Get Performance Counter Values Average Over Time...................................................... 366 Set Performance Log Counters .................................................................................... 368 Start Performance Log ................................................................................................ 369 Stop Performance Log ................................................................................................ 370 Update Performance Log Settings ................................................................................ 371 Wait for Performance Counter Value ............................................................................. 373

Process Actions .......................................................................................................... 375

Check if Process is Running ......................................................................................... 376 Kill Process ............................................................................................................... 377 Kill Process by PID ..................................................................................................... 378 Plain TCP String Request ............................................................................................ 379 Run Command Line .................................................................................................... 380 Run Process .............................................................................................................. 382 Run Windows Process ................................................................................................. 384 Telnet Session ........................................................................................................... 386 Wait for Processes ..................................................................................................... 387

Security Actions ......................................................................................................... 389

Authenticate User ...................................................................................................... 389 Change Credentials for Windows Service....................................................................... 390 Change Owner of File or Folder .................................................................................... 391 Check if Specific User has Administrative Rights ............................................................ 392 Check if Specific User has Permissions on File or Folder .................................................. 393 Check if User has Root Credentials ............................................................................... 394 IIS - Issue and Assign Server Certificate ....................................................................... 395 IIS - Toggle SSL on a Virtual Directory ......................................................................... 396 IIS - Toggle SSL on a Website ..................................................................................... 397

SNMP Actions ............................................................................................................. 399

Send SNMPv1 Trap .................................................................................................... 399 Send SNMPv2c Trap ................................................................................................... 401 Send SNMPv3 Trap .................................................................................................... 402

Contents


Source Control Actions ............................................................................................... 405

Subversion (SVN) Actions ........................................................................................... 405 SVN - Check Out ................................................................................................... 405 SVN - Commit ...................................................................................................... 407 SVN - Create Branch / Tag ..................................................................................... 408 SVN - Export ........................................................................................................ 409 SVN - Update ....................................................................................................... 410

Team Foundation Server (TFS) 2008 Actions ................................................................. 411 TFS 2008 - Check In.............................................................................................. 411 TFS 2008 - Check Out ........................................................................................... 412 TFS 2008 - Create Workspace ................................................................................ 413 TFS 2008 - Delete a Workspace .............................................................................. 414 TFS 2008 - Get Version .......................................................................................... 415

Team Foundation Server (TFS) 2010 Actions ................................................................. 417 TFS 2010 - Check In.............................................................................................. 417 TFS 2010 - Check Out ........................................................................................... 418 TFS 2010 - Create Workspace ................................................................................ 419 TFS 2010 - Delete a Workspace .............................................................................. 421 TFS 2010 - Get Version .......................................................................................... 423

SSH Actions ................................................................................................................ 425

Check if File or Folder Exists (SSH) .............................................................................. 425 Get File (SSH) ........................................................................................................... 427 Put File (SSH) ........................................................................................................... 428 Run Command (SSH) ................................................................................................. 429

Sun-Solaris Administration Actions ............................................................................ 431

Package Actions......................................................................................................... 431 Solaris - Add Package To Spool ............................................................................... 431 Solaris - Get Package Information ........................................................................... 432 Solaris - Install Package ......................................................................................... 434 Solaris - List All Files In Package ............................................................................. 435 Solaris - List All Packages....................................................................................... 436 Solaris - List Packages Referring To File ................................................................... 437 Solaris - Remove Package From Spool ..................................................................... 438 Solaris - Uninstall Package ..................................................................................... 439 Solaris - Verify Package Installation......................................................................... 440

Service Actions .......................................................................................................... 441 Solaris - Disable Service Instance ........................................................................... 441 Solaris - Enable Service Instance ............................................................................ 442 Solaris - Get Service Information ............................................................................ 443

Contents


Solaris - Get Service Problems ................................................................................ 444 Solaris - Get Service Properties............................................................................... 445 Solaris - Install Service From Manifest ..................................................................... 446 Solaris - List All Service Instances ........................................................................... 447 Solaris - List All Service Processes ........................................................................... 448 Solaris - List Service's Dependencies ....................................................................... 449 Solaris - List Service's Dependents .......................................................................... 450 Solaris - Refresh Service Instance ........................................................................... 451 Solaris - Restart Service Instance ........................................................................... 452 Solaris - Uninstall Service ...................................................................................... 453

System Actions ........................................................................................................... 455

Check Free Disk Space ............................................................................................... 455 Check Number of CPUs ............................................................................................... 456 Check OS Type .......................................................................................................... 457 Check the Amount of Physical Memory ......................................................................... 458 Get Current Date ....................................................................................................... 459 Get Current Date and Time ......................................................................................... 460 Restart Agent ............................................................................................................ 461 Restart Host .............................................................................................................. 462 Update Environment Variable ...................................................................................... 463

Text Actions ............................................................................................................... 465

Add Text to a File ...................................................................................................... 465 Extract Regular Expression Text from String ................................................................. 467 Extract Text from a File .............................................................................................. 468 Find Text in File ......................................................................................................... 469 Find Text in HTML ...................................................................................................... 471 Log to File on Serena Center ....................................................................................... 473 Read String Array from Text File .................................................................................. 474 Read String from Text File .......................................................................................... 475 Replace Text in File .................................................................................................... 476 Replace Text in Multiple Files ....................................................................................... 477 Update Value in Array (String) .................................................................................... 478 Write Array to Text File .............................................................................................. 479

VMWare Actions ......................................................................................................... 481

Cluster Actions .......................................................................................................... 481 VM - Add ESX Host To Cluster................................................................................. 481 VM - Get Clusters .................................................................................................. 483

Datacenter Actions ..................................................................................................... 484 VM - Add ESX Host To VCenter ............................................................................... 484

Contents


VM - Get Datacenters ............................................................................................ 486 VM - Get Datastores .............................................................................................. 487 VM - Get Hosts ..................................................................................................... 488 VM - Remove Host ................................................................................................ 489

Host Actions .............................................................................................................. 490 Maintenance Actions .............................................................................................. 490 Power Actions ....................................................................................................... 495

Network Actions ........................................................................................................ 499 VM - Add Host Virtual Adapter ................................................................................ 499 VM - Add Port Group ............................................................................................. 501 VM - Add Virtual Ethernet Card To VM ..................................................................... 503 VM - Add Virtual Switch ......................................................................................... 504 VM - Get All Host Virtual Adapters ........................................................................... 506 VM - Get All Virtual Switches .................................................................................. 507 VM - Get All VM Virtual Ethernet Cards .................................................................... 508 VM - Get Host Virtual Adapter Config ....................................................................... 509 VM - Get Port Group Config .................................................................................... 511 VM - Get Virtual Ethernet Card Config ...................................................................... 513 VM - Get Virtual Switch Config ................................................................................ 515 VM - Remove Host Virtual Adapter .......................................................................... 517 VM - Remove Port Group........................................................................................ 519 VM - Remove Virtual Ethernet Card From VM ............................................................ 520 VM - Remove Virtual Switch ................................................................................... 521 VM - Update Host Virtual Adapter ............................................................................ 522 VM - Update Port Group ......................................................................................... 524 VM - Update Virtual Switch ..................................................................................... 525

Template Actions ....................................................................................................... 527 Clone Action ......................................................................................................... 527 Convert Actions .................................................................................................... 529 Deploy Actions ...................................................................................................... 531

Virtual Machine Actions............................................................................................... 537 Adminstrate Actions .............................................................................................. 537 Migrate Actions ..................................................................................................... 553 Power Actions ....................................................................................................... 558 Snapshot Actions .................................................................................................. 565

Web Actions ............................................................................................................... 573

IIS Actions ................................................................................................................ 573 IIS - Add ISAPI Filter ............................................................................................. 573 IIS - Add ISAPI WEB Service Extension Files ............................................................ 575

Contents


IIS - Check Application Pool State ........................................................................... 576 IIS - Configure IP Access Restrictions to a Virtual Directory ........................................ 577 IIS - Configure IP Access Restrictions to a Web Site .................................................. 578 IIS - Create a Web Site.......................................................................................... 579 IIS - Create an Application Pool .............................................................................. 580 IIS - Create Virtual Directory .................................................................................. 581 IIS - Define Logging Schedule ................................................................................ 582 IIS - Define ODBC Logging Schedule ....................................................................... 583 IIS - Edit Allow/Prohibit Status of an ISAPI WEB Service Extension ............................. 584 IIS - Edit Allow/Prohibit Status of One or More ISAPI WEB Service Extension Files ........ 585 IIS - Edit Authentication Methods on a Virtual Directory ............................................. 586 IIS - Edit Authentication Methods on a Web Site ....................................................... 588 IIS - Edit ISAPI Filter ............................................................................................. 590 IIS - Issue and Assign Server Certificate .................................................................. 591 IIS - Modify Application Pool - 'Health' Tab ............................................................... 592 IIS - Modify Application Pool - 'Identity' Tab ............................................................. 593 IIS - Modify Application Pool - 'Performance' Tab ...................................................... 594 IIS - Modify Application Pool - 'Recycling' Tab ........................................................... 596 IIS - Modify File or Directory - HTTP Headers Tab ..................................................... 597 IIS - Modify Virtual Dir Path ................................................................................... 598 IIS - Modify Directory or Virtual Directory - 'Custom Errors' Tab ................................. 599 IIS - Modify Directory or Virtual Directory - 'Documents' Tab ...................................... 600 IIS - Modify Directory or Virtual Directory - 'HTTP Headers' Tab .................................. 601 IIS - Modify Directory or Virtual Directory - 'Virtual Directory' Tab............................... 602 IIS - Modify Web Site - 'Custom Errors' Tab ............................................................. 606 IIS - Modify Web Site - 'Documents' Tab .................................................................. 607 IIS - Modify Web Site - 'Home Directory' Tab............................................................ 608 IIS - Modify Web Site - 'HTTP Headers' Tab .............................................................. 611 IIS - Modify Web Site - 'Performance' Tab ................................................................ 612 IIS - Modify Web Site - 'Web Site' Tab ..................................................................... 613 IIS - Modify Web Site - ASP.NET Version .................................................................. 614 IIS - Modify Web Site - File-File Tab ........................................................................ 615 IIS - Modify Web Site - Logging Properties ............................................................... 616 IIS - Perform Operation on an Application Pool ......................................................... 618 IIS - Prohibit All ISAPI WEB Service Extensions ........................................................ 619 IIS - Remove a Virtual Directory ............................................................................. 620 IIS - Remove a Web Site ....................................................................................... 621 IIS - Remove an ISAPI Filter .................................................................................. 622 IIS - Remove an ISAPI WEB Service Extension ......................................................... 623 IIS - Remove ISAPI WEB Service Extension Files ...................................................... 624

Contents


IIS - Toggle SSL on a Virtual Directory .................................................................... 625 IIS - Toggle SSL on a Website ................................................................................ 626

IIS7 Actions .............................................................................................................. 627 IIS7 - Application Pool Tasks .................................................................................. 627 IIS7 - Assign an Application to an Application Pool .................................................... 628 IIS7 - Change an Application Pool for an Application .................................................. 629 IIS7 - Check Application Pool State ......................................................................... 630 IIS7 - Check if a virtual directory exists ................................................................... 631 IIS7 - Check if a website exists ............................................................................... 632 IIS7 - Check if an application exists ........................................................................ 633 IIS7 - Check if an application pool exists .................................................................. 634 IIS7 - Create an Application Pool ............................................................................ 635 IIS7 - Create a Virtual Directory ............................................................................. 636 IIS7 - Create a Web Application .............................................................................. 637 IIS7 - Create a Website ......................................................................................... 638 IIS7 - Delete an Application Pool ............................................................................. 639 IIS7 - Delete a Virtual Directory .............................................................................. 640 IIS7 - Delete a Website ......................................................................................... 641 IIS7 - Edit Application Pool Identity ......................................................................... 642 IIS7 - Modify a Virtual Directory ............................................................................. 643 IIS7 - Modify Website Logging ................................................................................ 644 IIS7 - Run Appcmd ............................................................................................... 645

URL Action ................................................................................................................ 646 Access URL........................................................................................................... 646

Find Text in HTML ...................................................................................................... 648 REST Operation ......................................................................................................... 650 SOAP Request ........................................................................................................... 652

XML Actions ................................................................................................................ 655

Delete an XML Attribute Using XPath ............................................................................ 655 Delete an XML Element Using XPath ............................................................................. 656 Execute an XPath Query ............................................................................................. 657 Insert an XML Attribute Using XPath............................................................................. 658 Insert an XML Element Using XPath ............................................................................. 659 Update an XML Attribute Using XPath ........................................................................... 660 Update an XML Element Using XPath ............................................................................ 661

Glossary ..................................................................................................................... 663

Index ....................................................................................................................... 667


Preface The Serena Release Automation Command Line Interface Guide accompanies the latest release of Serena Release Automation.

About this Document This document is a reference of action templates that can be used in designing a server-based application using Serena Release Automation.

The material covered in the present document is the sole property of Serena Software, Inc., and may not be copied or reproduced in any fashion without explicit written permission from Serena.

At the same time, Serena Software, Inc. is not liable for any information, correct or incorrect, appearing in this document that may result in damages incurred by the user regardless of whether or not such damages resulted from the information provided herein, in conjunction with or totally independent from the use of Serena Release Automation.

Intended Audience This documentation is intended for development and/or QA personnel who will work in Serena Release Automation to design the application whose various components will be deployed, implemented, and maintained by means of the automated processes generated by Serena Release Automation.

Related Documentation For information on using Serena Release Automation to develop automated processes and execute them, refer to the Serena Release Automation User's Guide.

For information on application software and version compatibility for actions, refer to the Serena Release Automation Applications Support Matrix.

Technical Support For comprehensive support options, contact Serena Support at http://support.serena.com.

http://support.serena.com/�


Chapter 1

Introduction

In This Chapter

Using the Actions Reference Guide .................................................................................................................. 19 Understanding Reference Terms...................................................................................................................... 19

Serena Release Automation enables you to automate the deployment of server-based applications.

The primary task in achieving a fully automated implementation of a server-based system involves designing the implementation as an application in Serena Release Automation. In the context of Serena Release Automation, an application comprises the components that enable client stations to display and interact with a software product that resides on an organization's server farm.

For each component, it is necessary to select and define the actions that will be available for designing the component's deployment. Defining an action is performed by selecting a predefined action template from Serena Release Automation's actions inventory and then modifying the action as desired.

Serena Release Automation's actions inventory comprises all action templates from the following sources:

• The default action templates library provided with Serena Release Automation

• Any additional action template libraries defined in Serena Release Automation

This guide provides detailed information on the various action templates included in the default library, and provides a convenient reference while designing applications and components.

For information on defining additional libraries, refer to the Serena Release Automation Installation and Administration Guide.

For detailed information on Serena Release Automation and designing applications, refer to the Serena Release Automation User's Guide.

Using the Actions Reference Guide The Actions Reference Guide is arranged alphabetically by the same Action categories that appear in the Serena application.

Understanding Reference Terms Input values are described as either Mandatory or Advanced. Mandatory values are required input, while Advanced values are optional input.

Chapter 1 Introduction


If a default value is available for an Action parameter, it will be presented.

Output values may or may not be present.


Chapter 2

Amazon EC2 Actions

In This Chapter

AMI Actions ..................................................................................................................................................... 21 Bundle Tasks Actions ...................................................................................................................................... 30 Elastic IP Actions ............................................................................................................................................. 36 Instance Actions .............................................................................................................................................. 42 Key Pair Actions .............................................................................................................................................. 57 Load Balancer Actions ..................................................................................................................................... 60 Security Group Actions .................................................................................................................................... 76 Snapshot Actions ............................................................................................................................................. 85 Volume Actions ................................................................................................................................................ 90

AMI Actions

EC2 - Create Image This action creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance.

Input Values

Mandatory

• Name ( String )

Name of the AMI that was provided during image creation.

• Access Key Id ( String )

Amazon Access Key ID that uniquely identifies the request sender (20-character alphanumeric sequence).

• Secret Access Key ( String )

Amazon Secret Access Key (a 40-character sequence).

• Instance Id ( String )

ID of the instance.

Chapter 2 Amazon EC2 Actions


Advanced

• Proxy Password ( String )

Password of the proxy of the internet connection.

• Proxy Port ( Integer )

Port number of the proxy.

• Description ( String )

Description of the AMI that was provided during image creation.

• No Reboot ( Boolean )

When set to true, Amazon EC2 does not shut down the instance before creating the image.

• Proxy User Name ( String )

User name of the proxy of the internet connection.

• Proxy Name ( String )

Name of the proxy host of the internet connection.

• Timeout ( Integer )

Timeout, in minutes, waiting for completion of image creating. If set to "0", the action does not wait. If set to "-1", the action waits without a time limit.

Output Values • Image Id ( String )

ID of the AMI.

AMI Actions


EC2 - Deregister Image This action deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.

Input Values

Mandatory



• Image Id ( String )

Unique ID of the AMI which was assigned during registration.



Advanced



• Proxy Password ( Password )






Output Values None



EC2 - Get Image Information This action returns the information about the specified Amazon AMI.

Input Values

Mandatory

• Secret Access Key



Image ID of the AMI used to launch the instance.

• Access Key Id


Advanced









Output Values • State Reason Message ( String )

Reason of the state change.

• Root Device Type ( String )

Root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.

• Image Location ( String[] )

Location of the AMI.

• Image State ( String )

Current state of the AMI.

AMI Actions


• Image Type ( String )

Type of the image (machine, kernel or ramdisk).


Description of the AMI that was provided during image creation.

• Product Codes ( String[] )

Product codes of the AMI.



EC2 - Register Instance This action adds new instances to the LoadBalancer.

Input Values

Mandatory



• Instance Id

Instance ID to be registered with the LoadBalancer.

• Load Balancer Name

Mnemonic name associated with the LoadBalancer. The name must be unique.

• Access Key Id


Advanced





• Proxy Port ( String )




Output Values • Registered Instances ( String[] )

Updated list of instances for the LoadBalancer.

AMI Actions


EC2 - Register Image This action registers an AMI with Amazon EC2. Images must be registered before they can be launched.

Input Values

Mandatory

• Image Location

Full path to your AMI manifest in Amazon S3 storage.

• Access Key Id

Amazon Access Key ID (20-character alphanumeric sequence) that uniquely identifies the request sender.


Amazon Secret Access Key (40-character sequence).

• Name

Name of the AMI that was provided during image creation.

Advanced


Description of the AMI.









Output Values • Image Id ( String )

Unique ID of the newly registered machine image.



EC2 - Start Existing AMI This action starts an existing AMI.

Input Values

Mandatory



• Group Name

Name of the group to modify. The name must be valid and belong to the account.

• Access Key Id


• Image Id

Unique ID of a machine image, returned to by a call.

• Key Name

Name of the key pair.

Advanced

• Source Security Group Owner ( String )

AWS User ID of an account. Cannot be used when specifying a CIDR IP address.

• Ip Protocol ( ProtocolType )

IP protocol ("tcp", "udp", "icmp").




Timeout, in minutes, waiting for the instance to start. If the timeout expires, no DNS name will be retrieved. If set to "0", the action does not wait. If set to "-1", the action waits until the instance starts and runs without a time limit.



• Source Security Group Name ( String )

Name of the security group. Cannot be used when specifying a CIDR IP address.

AMI Actions


• Cidr Ip ( String )

CIDR range.



• To Port ( Integer )

End of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).



• From Port ( Integer )

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e. any ICMP type number).

Output Values • Key Material ( String )

Unencrypted PEM encoded RSA private key.

• Dns Name ( String )

Public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network.

• Key Fingerprint ( String )

SHA-1 digest of the DER encoded private key.

• Instance State ( String )

Current state of the instance.


Unique ID of the instance launched.



Bundle Tasks Actions

EC2 - Bundle Instance This action bundles the Windows instance. During bundling, only the root store (C:\) is bundled. Data on other instance stores is not preserved.

Input Values

Mandatory

• Prefix ( String )

Specifies the beginning of the file name of the AMI.


ID of the instance to bundle.

• Bucket ( String )

Bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf.



• Aws Access Key ( String )

Access Key ID of the owner of the Amazon S3 bucket.



Advanced

• Aws Secret Access Key ( String )

Amazon Secret Access Key of the owner of the Amazon S3 bucket, used for creating upload policy dynamically.


Timeout, in minutes, waiting for bundle process completion. If set to 0, the action does not wait. If set to -1, the action waits without time limit.

• Upload Policy ( String )

Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on behalf of the user.

• Upload Policy Signature ( String )



Signature of the Base64 encoded JSON document.









Output Values • Bundle Id ( String )

Identifier for this task.

• Bundle State ( String )

State of the task.

• Progress ( String )

Level of task completion, in percent (e.g. 20%).



EC2 - Cancel Bundle Task This action cancels an Amazon EC2 bundling operation.

Input Values

Mandatory

• Bundle Id ( String )

ID of the bundle task to cancel.





Advanced









Output Values • Instance Id ( String )

Instance associated with this bundle task.




Bucket in which to store the AMI.


State of the task.





• Error Message ( String )

Error message.

• Error Code ( String )

Error code.



EC2 - Get Bundle Task Information This action describes the specified bundle task.

Input Values

Mandatory

• Access Key Id


• Bundle Id

ID of the bundle task to describe.



Advanced









Output Values • Error Code ( String )

Error code.


Error message.


State of the task.






Instance associated with this bundle task.




Bucket in which to store the AMI.



Elastic IP Actions

EC2 - Allocate Address This action acquires an elastic IP address for use with the account.

Input Values

Mandatory





Advanced









Output Values • Public IP ( String )

IP address for use with the account.

Elastic IP Actions


EC2 - Associate Address This action associates an elastic IP address with the instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance.

Input Values

Mandatory



• Public Ip ( String )

IP address for use with the account.


Instance to associate with the IP address.



Advanced









Output Values None



EC2 - Disassociate Address This action disassociates the specified elastic IP address from the instance to which it is assigned.

Input Values

Mandatory

• Public Ip ( String )

IP address that you are disassociating from the instance.





Advanced









Output Values None

Elastic IP Actions


EC2 - Get Address Instance This action gets instance id of the specific elastic IP address.

Input Values

Mandatory

• Access Key Id




• Input Public IP

Elastic IP address to describe.

Advanced










ID of the instance.



EC2 - List All Addresses This action lists elastic IP addresses assigned to the account.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Public Ips ( String[] )

Public IP addresses.

Elastic IP Actions


EC2 - Release Address This action releases an elastic IP address associated with your account.

Input Values

Mandatory

• Public Ip

IP address that is released from the account.

• Access Key Id




Advanced









Output Values None



Instance Actions

EC2 - Disable Monitoring on Running Instances This action disables monitoring for a running instance.

Input Values

Mandatory






Instance IDs to disable the monitoring.

Advanced









Output Values • Monitor State ( String )

States of monitoring for the instance.

Instance Actions


EC2 - Get Console Output This action retrieves console output for the specified instance. Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post.

Input Values

Mandatory

• Instance Id

ID of the instance for which you want console output.



• Access Key Id


Advanced









Output Values • Output Data ( String )

Console output, Base64 encoded.



EC2 - Get Instance Information This action returns information about the Amazon instance. If the instance does not exist, the action will fail.

Input Values

Mandatory


Amazon Secret Access Key.

• Access Key ID ( String )

Amazon Access Key ID that uniquely identifies the request sender.

• Instance ID

Instance ID for which the information will be retrieved.

Advanced







• Proxy Password


Output Values • Ram Disk Id ( String )

RAM disk associated with the instance.

• Dns Name ( String )

Public DNS name assigned to the instance. This DNS name is contactable from outside Amazon EC2 network.


Image ID of the AMI used to launch the instance.

• Monitoring State ( String )

State of monitoring for the instance.

Instance Actions


• Availability Zone (String )

Availability Zone of the instance.

• Key Name ( String )

If this instance was launched with an associated key pair, this displays the key pair name

• Group Set ( String [] )

Names of the Security groups.

• Kernel Id ( String )

Kernel associated with this instance.

• Instance Status ( String )


• Instance Type ( String )

Instance type.



EC2 - Get Password This action retrieves the instance password from Amazon.

Input Values

Mandatory

• Access Key Id (String )

Amazon Access Key ID that uniquely indentifies the request sender.

• Instance Id (String )

ID of the instance for which to get the password.

• Secret Access Key (String )


Advanced

• Pem File Path ( String )

Full path to the pem file with the RSA private key.

• Input Private Key ( String )

Text of the RSA key.

• Proxy Password








Output Values • Output Password ( String )

Decrypted password of the instance.

• Output Password Data ( String )

Password of the instance.

Instance Actions


EC2 - List All Instances This action returns IDs of all instances owned by the account.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Instance Ids ( String[] )

Unique IDs of the instance launched.



EC2 - Modify Instance Attributes This action enables modifications to an Amazon EBS instance attributes.

Input Values

Mandatory



• Access Key Id


• Instance Id

Instance IDs.

Advanced





• Ramdisk Id ( String )

ID of the RAM disk to select.

• Proxy Password ( Password )


• Disable Api Termination ( Boolean )

Whether the instance can be terminated using the APIs.


User name of the proxy of the internet connections.


ID of the kernel with which to launch the instance.

• Shutdown Behavior ( ShutdownBehaviorType )

Whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down.

• Instance Type ( InstanceType )

Instance Actions


Instance type.

• User Data ( String )

MIME, Base64-encoded user data.

Output Values None



EC2 - Monitor Instance This action enables monitoring for a running instance.

Input Values

Mandatory

• Instance Id

Instance ID to monitor.

• Access Key Id




Advanced









Output Values • Monitor State ( String )

State of monitoring for the instance.

Instance Actions


EC2 - Reboot Instance This action requests a reboot of the specified instance.

Input Values

Mandatory

• Access Key Id




• Instance Id

Instance ID.

Advanced









Output Values None



EC2 - Run Instance This action runs (creates) a new Amazon instance.

Input Values

Mandatory


ID of the AMI.




Amazon Access Key ID that uniquely identifies the request sender.

Advanced



• Availability Zone ( String )

Name of the Availability Zone.

• Instance Type ( InstanceType )

Instance type.

• Subnet Id ( String )

Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.



• Monitoring enabled ( Boolean )

Enables monitoring for the instance.

• Disable Api Termination ( Boolean )

Specifies whether the instance can be terminated using the APIs.


Name of the key pair.

• Security Group ( String )

Name of the security group.

Instance Actions


• User data ( string )

MIME, Base64-encoded user data.



• Additional Info ( String )

Additional information to make available to the instance(s).

• Ramdisk Id ( String )

ID of the RAM disk to select.




ID of the kernel with which to launch the instance.

• Shutdown Behavior ( ShutdownBehaviorType )

Specifies whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down. Valid value is "stop" or "terminate".

Output Values • Instance Id Out ( String )

Unique ID of the instance launched.

• Instance States Out ( String )




EC2 - Start Instance This action starts an instance that uses an Amazon EBS volume as its root device.

Input Values

Mandatory



• Access Key Id


• Instance Id

Instance ID.

Advanced









Output Values • Current State ( String )


• Previous State ( String )

Previous state of the instance.

Instance Actions


EC2 - Stop Instance This action stops an instance that uses an Amazon EBS volume as its root device.

Input Values

Mandatory

• Access Key Id


• Instance Id

Instance ID.



Advanced









• Force ( Boolean )

Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Output Values • Previous State ( String )

Previous state of the instance.

• Current State ( String )




EC2 - Terminate Instance This action shuts down the specified instance.

Input Values

Mandatory

• Instance Id

Instance ID.

• Access Key Id

Amazon Access Key ID (20-character alphanumeric sequence) unique identifier for request sender.



Advanced









Output Values • Current State ( String )

Current states of the instance.

• Previous State ( String )

Previous states of the instances.

Key Pair Actions


Key Pair Actions

EC2 - Create Key Pair This action creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is displayed on the output parameters. The private key is returned as an unencrypted PEM encoded PKCS#8 private key.

Input Values

Mandatory



• Input Key Name ( String )

Unique name for the key pair.



Advanced









Output Values • Key Fingerprint ( String )



Key pair name provided in the original request.

• Key Material ( String )

Unencrypted PEM encoded RSA private key.



EC2 - Delete Key Pair This action deletes the specified key pair by removing the public key from Amazon EC2.

Input Values

Mandatory


Name of the key pair to delete.





Advanced









Output Values None

Key Pair Actions


EC2 - List All Key Pairs This action enumerates available key pairs.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Key Names ( String[] )

Key pair name provided in the original request.

• Key Fingerprints ( String[] )




Load Balancer Actions

EC2 - Configure Health Check This action defines an application health check for the instances of the specified Load Balancer.

Input Values

Mandatory





• Target ( String )

Instance being checked. The protocol is either TCP or HTTP. The examples: "TCP:5000" or "HTTP:80/weather/us/wa/seattle".

• Load Balancer Name ( String )

Mnemonic name associated with the LoadBalancer. The name must be unique within the AWS account.

Advanced









• Unhealthy Threshold ( Integer )

Number of consecutive health probe failures that move the instance to the Unhealthy state. Valid value lies between 2 and 10.




Amount of time (in seconds) during which no response means a failed health probe. Valid value must be between 2 seconds and 60 seconds. Also, the timeout value must be less than the Interval value.

• Interval ( Integer )

Approximate interval (in seconds) between health checks of an individual instance. Valid interval must be between 5 seconds and 300 seconds. Also, the interval value must be greater than the Timeout value.

• Healthy Threshold ( Integer )

Number of consecutive health probe successes required before moving the instance to the Healthy state. Valid value lies between 2 and 10.

Output Values None



EC2 - Create LoadBalancer This action creates a new LoadBalancer.

Input Values

Mandatory

• Availability Zones ( String )

List of Availability Zones. The Availability Zones specified must be in the same EC2 Region as the LoadBalancer. You must specify at least one Availability Zone.



• Load Balancer Ports ( Integer )

External TCP ports of the LoadBalancer. Valid LoadBalancer ports are - 80, 443 and 1024 through 65535.



• Instance Ports ( Integer )

TCP ports on which the server on the instance is listening. Valid instance ports are one (1) through 65535.

• Protocols ( String )

LoadBalancer transport protocol to use for routing - TCP or HTTP.



Advanced











Output Values • Dns Name ( String )

DNS name for the LoadBalancer.



EC2 - Delete LoadBalancer This action deletes the specified LoadBalancer. On deletion, all of the configured properties of the LoadBalancer will be deleted.

Input Values

Mandatory







Advanced









Output Values None



EC2 - Disable Availability Zones for LoadBalancer This action removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer.

Input Values

Mandatory




Name of the Availability Zone to be removed from the LoadBalancer.


Mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.



Advanced









Output Values • Availability Zones ( String[] )

Updated list of Availability Zones for the LoadBalancer.



EC2 - Enable Availability Zones for LoadBalancer This action adds one or more EC2 Availability Zones to the LoadBalancer.

Input Values

Mandatory

• Availability Zone

New Availability Zone for the LoadBalancer. The Availability Zone must be in the same Region as the LoadBalancer.




Mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.

• Access Key Id


Advanced










Updated list of Availability Zones for the LoadBalancer.



EC2 - Get Availability Zone Information This action returns information about the specified Availability Zone.

Input Values

Mandatory



• Zone Name

Availability Zone name.

• Access Key Id


Advanced









Output Values • Zone State ( String )

State of the Availability Zone.

• Region Name ( String )

Name of the Region.



EC2 - Get Health Check for Load Balancer This action returns health check for the specified load balancer.

Input Values

Mandatory




Mnemonic name associated with the LoadBalancer.

• Access Key Id


Advanced









Output Values • Healthy Threshold ( Integer )

Number of consecutive health probe successes required before moving the instance to the Healthy state.

• Interval ( Integer )

Approximate interval (in seconds) between health checks of an individual instance.

• Unhealthy Threshold ( Integer )

Number of consecutive health probe failures that move the instance to the unhealthy state.

• Target ( String )



Instance being checked. The protocol is either TCP or HTTP. The examples: "TCP:5000" or "HTTP:80/weather/us/wa/seattle".


Amount of time (in seconds) during which no response means a failed health probe.



EC2 - List All Availability Zones This action returns a list of Availability Zones that are currently available to the account.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Zone Names ( String[] )

Names of Availability Zones.



EC2 - List All LoadBalancers This action enumerates all Amazon ELB Load Balancers.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Load Balancer Names ( String[] )

Array of mnemonic names that were associated with the LoadBalancer.



EC2 - List Availability Zones in Load Balancer This action returns list of Availability Zones enabled in the specified Load Balancer.

Input Values

Mandatory



• Access Key Id




Advanced










List of Availability Zones.



EC2 - List Instances in Load Balancer This action returns list of instances registered in the specified LoadBalancer.

Input Values

Mandatory



• Access Key Id




Advanced









Output Values • Instances ( String[] )

List of instance IDs. EC2 instances comprise the instances for the LoadBalancer.



EC2 - Register Instance This action adds new instances to the LoadBalancer.

Input Values

Mandatory



• Instance Id

Instance ID to be registered with the LoadBalancer.



• Access Key Id


Advanced













EC2 - Unregister Instance This action deregisters instance from the LoadBalancer. Trying to deregister an instance that is not registered with the LoadBalancer does nothing.

Input Values

Mandatory

• Access Key Id




• Instance Id

List of EC2 instance IDs consisting of all instances you want to be deregistered.



Advanced



• Proxy Password ( String)










Security Group Actions

EC2 - Add Permissions to Security Group This action adds permissions to a security group. When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission, GroupName, IpProtocol, FromPort, ToPort, and CidrIp must be specified. Mixing these two types of parameters is not allowed.

Input Values

Mandatory





• Group Name ( String )


Advanced




CIDR range.




End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e. any ICMP code).















Output Values None



EC2 - Create Security Group This action creates a new security group.

Input Values

Mandatory



• Group Description ( String )

Description of the security group. This is informational only.



• Access Key Id


Advanced









Output Values None



EC2 - Delete Security Group This action deletes a security group.

Input Values

Mandatory







Advanced









Output Values None



EC2 - List All Security Groups This action enumerates all security groups.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Group Names ( String[] )

Names of the security group.



EC2 - List Security Group Permissions This action enumerates the permissions of the specified security group.

Input Values

Mandatory

• Access Key Id




• Group Name


Advanced









Output Values • Group Description ( String )

Description of the security group.

• Ip Protocols ( String[] )

IP protocols.

• From Ports ( Integer[] )


• Group Names ( String[] )

Names of the security group of AWS accounts. Cannot be used when specifying a CIDR IP address.



• User Ids ( String[] )

AWS User ID of accounts. Cannot be used when specifying a CIDR IP address.

• To Ports ( Integer[] )

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e. any ICMP code).

• Cidr Ips ( String[] )

CIDR ranges.



EC2 - Remove Permissions from Security Group This action revokes permissions from a security group.

Input Values

Mandatory

• Access Key Id




• Group Name


Advanced






End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).




Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).






CIDR range.







Output Values None

Snapshot Actions


Snapshot Actions

EC2 - Create Snapshot This action creates a snapshot of an Amazon EBS volume and stores it in Amazon S3.

Input Values

Mandatory




Amazon Access Key ID uniquely identifying request sender (20-character alphanumeric sequence).

• Volume Id ( String )

ID of the Amazon EBS volume of which to take a snapshot.

Advanced


Description of the Amazon EBS snapshot.









Output Values • Status ( String )

Snapshot state (e.g. pending, completed, or error).

• Snapshot Id ( String )

ID of the snapshot.



EC2 - Delete Snapshot This action deletes a snapshot of an Amazon EBS volume.

Input Values

Mandatory




ID of the snapshot.



Advanced









Output Values None

Snapshot Actions


EC2 - Get Snapshot Information This action returns information about the specified Amazon EBS snapshot available to the user.

Input Values

Mandatory



• Snapshot Id

ID of the snapshot.

• Access Key Id


Advanced









Output Values • Volume Size ( String )

Size of the volume, in GBs.

• Owner Id ( String )

AWS Access Key ID of the user who owns the snapshot.

• Owner Alias ( String )

AWS account alias (e.g. "amazon", "redhat", "self", etc.) or AWS account ID that owns the AMI.


ID of the volume.



• Status ( String )

Snapshot state (e.g. pending, completed, or error).


Description of the snapshot.

Snapshot Actions


EC2 - List All Snapshots This action enumerates all Amazon EBS snapshots available to the user.

Input Values

Mandatory



• Access Key Id


Advanced









Output Values • Snapshot Ids ( String[] )

IDs of the snapshot.



Volume Actions

EC2 - Attach Volume This action attaches an Amazon EBS volume to a running instance exposing it as specified device.

Input Values

Mandatory


ID of the volume.


ID of the instance to which the volume attaches.



• Access Key Id ( String)


• Device ( String )

Specifies how the device is exposed to the instance (e.g. /dev/sdh).

Advanced










Volume state.

Volume Actions


EC2 - Create Volume This action creates a new Amazon EBS volume to which any Amazon EC2 instance can attach within the same Availability Zone. A new volume can be created from the scratch using size of the volume, or from the specified snapshot.

Input Values

Mandatory




Availability Zone in which to create the new volume.



Advanced



• Proxy User Name ( String)







Snapshot from which to create the new volume.

• Size ( Integer )

Size of the volume, in GBs. Required if you are not creating a volume from a snapshot. Valid Values: 1 to 1024.

Output Values • Volume Id ( String )

ID of the volume.



EC2 - Delete Volume This action deletes an Amazon EBS volume.

Input Values

Mandatory


ID of the volume.





Advanced









Output Values None

Volume Actions


EC2 - Detach Volume This action detaches an Amazon EBS volume from an instance.

Input Values

Mandatory






ID of the volume.

Advanced


Forces detachment if previous detachment attempt did not occur cleanly: logging into instance, unmounting volume, detaching normally. This option can lead to data loss or corrupted file system.


Device name.







Instance Id ( String )

ID of the instance.




Volume state.



EC2 - Get Volume Information This action returns the information about the specified Amazon EBS volume.

Input Values

Mandatory

• Volume Id

ID of the volume.

• Access Key Id




Advanced










ID of the instance.

• Size ( String )

Size of the volume, in GBs.


Availability Zones in which the volume was created.

• Delete On Termination ( Boolean )

Whether the Amazon EBS volume is deleted on instance termination.

Volume Actions


• Attachment Status ( String )

Attachment state.


Specifies how the device is exposed to the instance.


Volume state.


Snapshot from which the volume was created.



EC2 - List All Volumes This action enumerates all Amazon EBS volumes.

Input Values

Mandatory

• Access Key Id




Advanced









Output Values • Volume Ids ( String[] )

IDs of the volume.

Chapter 3

Application Server Actions

In This Chapter

WebLogic Actions ............................................................................................................................................ 97 WebSphere Actions ....................................................................................................................................... 117

WebLogic Actions To properly use the Serena Action Pack for WebLogic Application Server (WLS), the following configurations must be performed on each Serena Agent machine that will execute WLS actions.

Configuring for WLS Actions on Serena Agent Machines

The folders described in the following procedure are those where the files are typically located.

To configure for WLS ac tions on Serena Agent machines :

On each Serena Agent machine that will execute a WLS action:

1 Copy the following WebLogic Client Runtime jar files from the WebLogic Application Server machine to <Serena Agent Home>/lib:

<WLS HOME/modules>com.bea.core.descriptor.sls_1.1.0.0.jar

<WLS HOME/server/lib>wlfullclient.jar

2 If wlfullclient.jar does not exist, create it using the following commands:

cd <WLS HOME>/server/lib

<Serena Agent Home>/jre/bin/java –jar ./wljarbuilder.jar

3 Stop and Start the Serena Agent service.

Chapter 3 Application Server Actions


WLS - Create Data Source This action creates a new JDBC Data Source.

Input Values

Mandatory

• User ( String )

Administrative user name.

• Db User Id ( String )

Database login user name.

• Db Url ( String )

Address of the database.

• Password ( Password )

Administrative password.

• Db Driver Class Path ( String )

Classpath of JDBC driver.

• Data Source Name ( String )

Name of the data source.

Advanced

• Timeout (Seconds) ( Integer )

Number of seconds to wait until a long-running operation completes. Zero (0) means no timeout. Default value is 0.

• Login Delay Seconds ( Integer )

Number of seconds to delay before creating each physical database connection. This delay supports database servers that cannot handle multiple connection requests in rapid succession. Default value is 0 (no delay).

• Target Names ( String )

Target server names, where Data Source should be created. Target list should be separated by commas only: server_1,server_2,...,server_n.

• Driver Property Values ( String[] )

Property values for the driver initialization.

• Shrink Frequency Seconds ( Integer )

WebLogic Actions


Number of seconds to wait before shrinking a connection pool that has incrementally increased to meet demand. Default value is 90.

• Address ( String )

Address of the WebLogic Server instance that hosts the MBean server. Default value is 'localhost'.

• Max Capacity ( Integer )

Maximum number of physical connections that this connection pool can contain. Default value is 15.

• Test Table Name ( String )

Name of the database table to use when testing physical database connections.

• Initial Capacity ( Integer )

Number of physical connections to create when creating the connection pool in the data source. This is also the minimum number of physical connections the connection pool will keep available. Default value is 1.

• JNDI Names ( String[] )

JNDI path to which this data source is bound. By default, the JNDI name is the name of the data source.

• Db Password ( Password )

Database login password.

• Driver Property Names ( String[] )

Property names for the driver initialization.

• Capacity Increment ( Integer )

Number of connections created when new connections are added to the connection pool. Default value is 1.

• Port ( Integer )

Port number of the WebLogic Server instance. Default value is 7001.

Output Values None



WLS - Delete Application This action undeploys an application from all deployed targets and deletes it from the domain.

Input Values

Mandatory

• Module Type ( ApplicationType )

Type of deployed application: WAR, EAR, JAR.

• User ( String )


• Application Name ( String )

Name of the application



Advanced







Output Values None

WebLogic Actions


WLS - Delete Data Source This action deletes the specified data source.

Input Values

Mandatory

• User ( String )




• Data Source Name ( String )


Advanced






Address of the WebLogic Server instance that hosts the MBean server. Default is 'localhost'.

Output Values None



WLS - Deploy Installed Application This action deploys an installed application to the target servers.

Input Values

Mandatory

• User ( String )





Type of application to deploy: WAR, EAR, JAR.

• Target server names ( String )

Target server names, where application should be deployed/redeployed. Target list should be separated with commas only: server_1,server_2,...,server_n.


Name of the application.

Advanced







Output Values None

WebLogic Actions


WLS - Get Application State This action retrieves the state of the specified application.

If a cluster is specified as the target, the application must be deployed to all the servers in the cluster.

If the target is a server that belongs to a cluster, server can be specified directly only if application is partially deployed on cluster. Note: When application is fully deployed on cluster, use cluster name.

Input Values

Mandatory



• Target Server ( String )

Name of the server where the application is deployed.



• User ( String )


Advanced

• Expected State ( ApplicationState )

The state in which you expect the application to be. If this parameter is filled and the application is not in this state, the action will fail.


Port number of the WebLogic Server instance Default value is 7001.





Output Values • Application State ( String )

State of the application.



WLS - Get Server(s) State This action retrieves the state of the specified server or cluster.

Input Values

Mandatory

• Server Name ( String )

Name of the server or cluster.

• User ( String )




Advanced







Output Values • Server State ( String )

State of the server.

WebLogic Actions


WLS - Install New Application This action installs a new application, deploys it to the target servers, and starts the deployed application. The action supports the following types: WAR, EAR, and JAR (EJB).

Input Values

Mandatory


Type of application to deploy: EAR, WAR, JAR.

• Application Path ( String )

Full path to the application file.



• User ( String )




Advanced









Output Values None



WAS - Create Informix Data Source Action This action creates Informix DataSource.

Input Values

Mandatory

• Name

Name of DataSource.

• Database Server Port Number

Connection port of the database.

• JDBC Provider Name

JDBC provider to support DataSource.

• Database Name ( String )

Name of database.

• JNDI Name

Java Naming and Directory Interface (JNDI) name.

• Database Server Name ( String )

Hostname or IP of the server machine on which the database is installed.

• Server bin directory path

Path to the WebSphere server bin directory on agent machine.

• Port

Port number as defined on server under SOAP_CONNECTOR_ADDRESS.

Default ports are:

STANDALONE_SERVER - 8880

NETWORK_DEPLOYMENT - 8879

Advanced

• Ifx IFXHOST ( String )

Physical machine name of the server hosting the Informix® instance. Property corresponds to the database attribute, ifxIFXHOST. Host name or IP address can be entered. IPv6 address may also be entered if the host database supports it.

• Informix Lock Mode Wait ( Integer )

WebLogic Actions


Connection wait time for obtaining a lock in the database. Property corresponds to the database attribute informixLockModeWait. By default, Informix® throws an exception when it cannot acquire a lock, rather than wait for the current owner of the lock to release it.

To not throw an exception when Informix cannot acquire a lock, set value to number of seconds to wait for the lock. Any negative value translates to unlimited wait time.

• Username ( String )

Username for connection to WebSphere. Required only if connection security is enabled.

• Scope ( Scope )

Level at which DataSource is visible: Cell [default], Cluster, Node, Server.

• Node ( String )

Node name. Mandatory if Scope is Node or Server.

• Authentication Alias for XA Recovery ( String )

Alias that connection factory uses to authenticate to EIS for transaction recovery. Valid only if JDBC provider supports XA transactions.

• Cluster ( String )

Cluster Name. Mandatory if Scope is Cluster.


Password for connection to WebSphere. Required only if connection security is enabled.

• Host ( String )

Deployment manager host name.

On standalone server, host is application server host name.

If Serena agent is running on Deployment manager machine, should be left empty.


Description of DataSource.

• Application Server ( String )

Server name. Mandatory if Scope is Server.

• Container Managed Persistence ( Boolean )

Whether DataSource is used for container managed persistence for enterprise beans.

• Timeout (seconds) ( Integer )

Time to wait until operation completes. Default value is 0 - unlimited wait.



Output Values None

WebLogic Actions


WLS - Resume Server(s) This action resumes the specified server in the domain.

Input Values

Mandatory

• User ( String )



Name of the server.



Advanced







Output Values None



WLS - Run WLST Script This action runs a WLST Python script in Oracle WebLogic server.

Input Values

Mandatory

• Script Source

Path of Python script file.

• Weblogic Home

WebLog root directory, for example, C:\Oracle\Middleware\wlserver_10.3.

Advanced



• Command Line Arguments ( String[] )

List of command line arguments to be accessed from the script using 'sys.argv[i]'.

Output Values • Execution Output ( String )

Output of the execution of the script.

WebLogic Actions


WLS - Shutdown Server(s) This action stops the specified server or cluster in the domain after handling in-flight work.

Input Values

Mandatory


Name of the server.



• User ( String )


Advanced

• Shutdown Timeout ( Integer )

Number of seconds to wait before aborting in-flight work and shutting down/suspending the server. Default value is 0 (no wait).



• Ignore Session ( Boolean )

Set to True to ignore pending HTTP sessions during in-flight work handling. Default value is False.





Output Values None



WLS - Start Application This action starts an application.

Input Values

Mandatory

• User ( String )






Advanced







Output Values None

WebLogic Actions


WLS - Start Server(s) This action starts the specified server or cluster in the domain.

Input Values

Mandatory


Name of the server.



• User ( String )


Advanced







Output Values None



WLS - Stop Application This action stops an application.

Input Values

Mandatory



• User ( String )




Advanced







Output Values None

WebLogic Actions


WLS - Suspend Server(s) This action suspends the specified server or cluster in the domain.

Input Values

Mandatory


Name of the server.

• User ( String )




Advanced







• Ignore Session ( Boolean )

Set to True to ignore pending HTTP sessions during in-flight work handling. Default value is True.

• Shutdown Timeout ( Integer )

Number of seconds to wait before aborting in-flight work and shutting down/suspending the server. Default value is 0 (no wait).

Output Values None



WLS - Undeploy Application This action removes a deployed application from the target servers.

Input Values

Mandatory





• User ( String )



Type of application to remove: WAR, EAR, JAR.



Advanced







Output Values None

WebSphere Actions


WebSphere Actions To properly use the Serena Action Pack for WebSphere Application Server (WAS), the following configurations must be performed on each Serena Agent machine that will execute WAS actions.

Configuring for WAS Actions on Serena Agent Machines

The folders described in the following procedure are those where the files are typically located.

To configure for WAS ac tions on Se rena Agent machines :

On each Serena Agent machine that will execute a WAS action:

1 Copy the following WebSphere Client Runtime jar file from the WebSphere Application Server machine to <Serena Agent Home>/lib:

<The AppServer/runtimes>ws_runtime.jar

2 If running WAS 6.1, copy the following Administration Thin Client jar from the WebSphere Application Server machine to <Serena Agent Home>/lib:

<The AppClient/runtimes>com.ibm.ws.webservices.thinclient_6.1.0.jar

3 If running WAS 7.0, copy the following Administration Thin Client jar from the WebSphere Application Server machine to <Serena Agent Home>/lib:

<The AppClient/runtimes>com.ibm.ws.admin.client_7.0.0.jar

4 Stop and Start the Serena Agent service.

WAS - Check Environment Variable Exists This action checks if an environment variable exists on WebSphere Application Server

Input Values

Mandatory

• Port


Default ports:



• Variable Name

Symbolic name for a WebSphere Application Server variable.





Advanced





• Host ( String )


On standalone server, Host is the application server host name.


• Node ( String )






• Scope ( Scope )

Level at which the resource is visible: Cell [default], Cluster, Node, Server.

• Should Exist ( Boolean )

Whether to expect the variable to exist.


Cluster name. Mandatory if Scope is Cluster.

Output Values None

WebSphere Actions


WAS - Create/Update Environment Variable This action creates or updates environment variable on WebSphere Application Server.

Input Values

Mandatory

• New Value

New value to set.

• Variable Name


• Port


Default ports are:





Advanced






New description to set. If update and not set, variable description will not be changed.

• Node ( String )




• Host ( String )










• Scope ( Scope )


Output Values • Old Value ( String )

If update, string will contain the old variable value.

If create, string will be empty.

WebSphere Actions


WAS - Create Data Source for User Defined JDBC Provider Action This action creates DataSource for user defined JDBC provider.

Input Values

Mandatory



• JNDI Name




• Port


Default ports are:



• Name

Name of DataSource.

Advanced

• Timeout (seconds ) ( Integer )



Whether data source is used for container managed persistence for enterprise beans.

• Host ( String )




• DataStore Helper Class Name ( String )



Data store helper class, an interface through which a DataSource is triggered by a database to perform functions specific to that database vendor.









• Scope ( Scope )

Level at which the DataSource is visible: Cell [default], Cluster, Node, Server.

• Node ( String )






Output Values None

WebSphere Actions


WAS - Create DB2 Data Source Action This action creates DB2 DataSource.

Input Values

Mandatory





• Port


Default ports are:



• JNDI Name


• Name

Name of DataSource.

Advanced



• Scope ( Scope )







Name of database.





• Driver Type ( DB2 _JDBC_DRIVER_TYPE )

JDBC connectivity type of a data source. Set to type 4 if you are running the application server for z/OS and connecting to DB2 UDB for iSeries.



• Host ( String )




• Database Server Port Number ( Integer )




• Node ( String )








Output Values None

WebSphere Actions


WAS - Create Derby Data Source Action This action creates Derby DataSource.

Input Values

Mandatory

• JNDI Name






• Name

Name of DataSource.

• Port


Default ports are:



• Database Name

Name of database.

Advanced

• Scope ( Scope )




• Node ( String )


• Host ( String )




















Output Values None

WebSphere Actions


WAS - Create JAAS - J2C Authentication Data Entry This action creates an alias for given user identity and password used by Java™ 2 Connector (J2C) security.

Input Values

Mandatory

• Alias

Name of the authentication data entry.

Important: The node name is automatically appended as a prefix to the alias name you specify, in the format: [node_name]/[alias_name]. The full alias name is used in your deployment descriptor, as well as in Serena actions, such as Create Data Source.

On WebSphere Application Server version 7.0, and greater, the default behavior may be customized. See WebSphere Application Server version 7.0 documentation for further details.



• Port


Default ports are:



• JAAS Password

Password to use for the target Enterprise Information System (EIS).

• User ID

J2C authentication data user ID.

Advanced


Optional description for the authentication data entry.

• Security Domain Name ( String )

Name of security domain configuration. The application server uses the global security configuration if no value is specified.

Security Domain Name is a feature of WebSphere Application Server version 7.0, and greater. For earlier versions, it is ignored.







• Host ( String )






Output Values None

WebSphere Actions


WAS - Create Microsoft SQL Server Data Source Action This action creates Microsoft SQL Server DataSource.

Input Values

Mandatory

• JNDI Name


• Database Name

Name of the database.





• Name

Name of DataSource.



• Port


Default ports are:





Advanced



• Node ( String )






• Host ( String )







Optional description for the authentication data entry.







• Scope ( Scope )




Output Values None

WebSphere Actions


WAS - Create Oracle Data Source Action This action creates Oracle DataSource.

Input Values

Mandatory





• DataStore Helper Class Name

Name of the DataStoreHelper implementation class that extends the capabilities of the selected JDBC driver implementation class to perform data-specific functions.

WebSphere Application Server provides a set of DataStoreHelper implementation classes for each of the JDBC provider drivers it supports.

• JNDI Name


• URL

Oracle Url of the database.

• Name

Name of DataSource

• Port


Default ports are:



Advanced

• Host ( String )






• Node ( String )

Node Name. Mandatory if Scope is Node or Server.




Description of data source.



• Scope ( Scope )



Alias that connection factory uses to authenticate with the EIS for transaction recovery. Valid only if JDBC provider supports XA transactions.






Server Name. Mandatory if Scope is Server.



Output Values None

WebSphere Actions


WAS - Create Sybase Data Source Action This action creates Sybase DataSource.

Input Values

Mandatory

• Database Server Name

Hostname or IP of server machine on which the database is installed.


Connection port of the database

• Database Name

Name of the Database

• Port


Default ports are:





• JNDI Name


• Name



JDBC provider to support DataSource,

Advanced




Alias that connection factory uses to authenticate with the EIS for transaction recovery. Valid only if JDBC provider supports XA transactions.




Description of the data source.



• Host ( String )










• Node ( String )

Node Name. Mandatory if Scope is Node or Server.

• Scope ( Scope )



Server Name. Mandatory if Scope is Server.

Output Values None

WebSphere Actions


WAS - Delete Environment Variable This action deletes an environment variable on WebSphere Application Server.

Input Values

Mandatory

• Port


Default ports are:



• Variable Name




Advanced









• Scope ( Scope )

Level at which the Resource is visible: Cell [default], Cluster, Node, Server.



• Node ( String )


• Host ( String )






Output Values • Old Value ( String )

Retrieves the variable value before the deletion.

WebSphere Actions


WAS - Delete JAAS - J2C Authentication Data Entry This action deletes a JAAS - J2C authentication data entry with the given alias.

Input Values

Mandatory



• Alias

Name of the authentication data entry to delete.

Important: The node name is automatically appended as a prefix to the alias name you specify, in the format: [node_name]/[alias_name]. The full alias name is used in your deployment descriptor, as well as in Serena actions, such as Create Data Source.

On WebSphere Application Server version 7.0, and greater, the default behavior may be customized. See WebSphere Application Server version 7.0 documentation for further details.

• Port


Default ports are:


NETWORK_DEPLOYMENT - 8879.

Advanced

• Host ( String )




• Security Domain Name ( String )

Name of security domain configuration. The application server uses the global security configuration if no value is specified.

Security Domain Name is a feature of WebSphere Application Server version 7.0, and greater. For earlier versions, it is ignored.







Output Values None

WebSphere Actions


WAS - Get Environment Variable Value This action retrieves the value of an environment variable on WebSphere Application Server.

Input Values

Mandatory

• Port


Default ports are:



• Variable Name




Advanced

• Node ( String )


• Scope ( Scope )




• Host ( String )














Output Values • Variable value ( String )

WebSphere variable value.

WebSphere Actions


WAS - Get Managed Server Status This action retrieves WebSphere application server status (ND).

Input Values

Mandatory



• Port


Default ports are:



• Node

Node name.

• Application Server

Application server name.

Advanced

• Host ( String )




• Expected server status ( ManagedServerStatus )

Application server expected status.

If actual status is not as expected, action will fail.

If left empty, action will pass regardless of the server's actual status.









Output Values • Actual Server Status ( String )

Application server status.

WebSphere Actions


WAS - Install Application This action installs a new application on clusters and servers. Supported Java formats are ear, war, jar and sar.

Input Values

Mandatory

• Application name

Application name.

• Port


Default ports are:





• File Path

Full path to Java module file. Path should be accessible from Serena agent host. Module should be one of following: EAR, WAR, JAR, SAR.

Advanced







• Context root ( String )

Application context root. Mandatory only for standalone Web modules: .war, .sar.

• Host ( String )






• Clusters ( String[] )

Target clusters.

• Options ( String )

Additional installation options. Options format is Python list of strings.

Use a single quote character (') to specify strings, for example, ['-preCompileJSPs', '-filepermission','.*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755'].

For more details about installation options, see IBM documentation for 'AdminApp' object.

• Application Servers ( String[] )

Target servers. Array of server name and node name pairs, separated by comma (,), for example, node1,server1.

Output Values None

WebSphere Actions


WAS - Launch Script This action runs a script on a WebSphere Application Server. Script language can be Jython or Jacl.

Input Values

Mandatory

• Path to script file

Path to script file.



• Port


Default ports are:



Advanced

• Script Language ( ScriptLanguageEnum )

Script language: Jython or Jacl.

• Host ( String )








• Command Line Arguments ( String[] )

List of command line arguments which can be accessed from the script using 'sys.argv[i]'.





Output Values Non

WebSphere Actions


WAS - Start Application This action starts an application on WebSphere application servers and clusters.

Input Values

Mandatory



• Port


Default ports are:




Application name.

Advanced



If both Application Servers and Clusters are empty, action will start application on all deployed targets.

• Host ( String )







Target clusters.

If both Application Servers and Clusters are empty, action will start application on all deployed targets.

• Pass on partial success ( Boolean )



If True, action will succeed if application is started on at least one server.

If False, action will fail if application fails to start on at least one server.





Output Values None

WebSphere Actions


WAS - Start Managed Server(s) This action starts the specified managed WebSphere application servers (ND) and clusters.

Input Values

Mandatory



• Port


Default ports are:



Advanced




Target servers. Array of server name and node name pairs, separated by comma (,), for example, node1, server1.






Clusters to start.

• Host ( String )





If True, action will succeed if at least one server or cluster member is started.



If False, action will fail if at least one server or cluster member failed to start.

Output Values None

WebSphere Actions


WAS - Start Server(s) This action starts servers and clusters. This action waits for server targets to reach RUNNING state. An attempt is made to start all servers and clusters. Action succeeds only if all servers and clusters are successfully started.

Input Values

Mandatory

• Server/Cluster Name(s)

Target Servers and Clusters to start. Use the following formats:

Cluster - 'clusterName'

Server - 'nodeName,serverName'

Separate multiple targets, whether server or cluster, with colons (:), as in the following examples:

2 Servers - 'node1,server1:node2,server2'

2 Clusters - 'cluster1:cluster2'

1 Cluster and 1 Server - 'cluster1:node1,server1'

• Port


Default ports are:



Advanced

• Key Store File ( String )

SSL keyStore file location. Required only if connection security is enabled. For example: '/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/etc/DummyClientKeyFile.jks'.

• Trust Store File ( String )

SSL trustStore key file location. Required only if connection security is enabled. For example: '/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/etc/DummyClientTrustFile.jks'.



• Host address ( String )

Application Server hostname.



• Trust Store Password ( Password )

SSL trustStore password. Required only if connection security is enabled.



• Platform ( PlatformParameters )

Platform:

UNIX

WINDOWS

Required only if Server Topology is STANDALONE_SERVER.

• SSL Security Enabled ( Boolean )

Whether connection security is enabled or not.

• Server Topology ( ServerTopology )

Standalone server or network deployment.



• Server profile bin path ( String )

Server profile path to bin directory. Required and is mandatory only if Server Topology is STANDALONE_SERVER.

• Key Store Password ( Password )

SSL keyStore password. Required only if connection security is enabled.

Output Values

WebSphere Actions


WAS - Start Standalone Server This action starts a WebSphere Application Standalone Server. If server is already started, action will fail.

Input Values

Mandatory




Application Server name.

Advanced







Output Values None



WAS - Stop Application This action stops an Application on WebSphere application servers and clusters.

Input Values

Mandatory


Application name.

• Port


Default ports are:





Advanced






If True, action will succeed if application is stopped on at least one server.

If False, action will fail if application fails to stop on at least one server.

• Host ( String )






WebSphere Actions


If both Application Servers and Clusters are empty, action will stop application on all deployed targets.


Target clusters. If both Application Servers and Clusters are empty, action will stop application on all deployed targets.



Output Values None



WAS - Stop Managed Server(s) This action stops the specified managed WebSphere application servers (ND) and clusters.

Input Values

Mandatory

• Port


Default ports are:





Advanced




If True, action will succeed if at least one server is stopped.

If False, action will fail if at least one server fails to stop.


Clusters to stop.





• Host ( String )





WebSphere Actions



Output Values None



WAS - Stop Server(s) This action stops servers and clusters. This action waits for the servers to reach STOPPED state. An attempt is made to stop all servers and clusters. Action succeeds only if all servers and clusters are successfully stopped

Input Values

Mandatory

• Port


Default ports are:



• Server/Cluster Name(s)

Target Servers and Clusters to start. Use the following formats:

Cluster - 'clusterName'

Server - 'nodeName,serverName'

Separate multiple targets, whether server or cluster, with colons (:), as in the following examples:

2 Servers - 'node1,server1:node2,server2'

2 Clusters - 'cluster1:cluster2'

1 Cluster and 1 Server - 'cluster1:node1,server1'

Advanced



• Host address ( String )

Application Server hostname.





• Key Store Password ( Password )

WebSphere Actions


SSL keyStore password. Required only if connection security is enabled.

• SSL Security Enabled ( Boolean )

Whether connection security is enabled or not.

• Trust Store File ( String )

SSL trustStore key file location. Required only if connection security is enabled. For example: '/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/etc/DummyClientTrustFile.jks'.

• Key Store File ( String )

SSL keyStore file location. Required only if connection security is enabled. For example: '/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/etc/DummyClientKeyFile.jks'.


SSL trustStore password. Required only if connection security is enabled.

Output Values None



WAS - Stop Standalone Server This action stops WebSphere Application Standalone Server. If server is already stopped, action will fail.

Input Values

Mandatory




Application Server name.

Advanced







Output Values None

WebSphere Actions


WAS - Uninstall Application This action uninstalls an application on WebSphere Application Server.

Input Values

Mandatory

• Port

Port number as defined on server under SOAP_CONNECTOR_ADDRESS:

STANDALONE_SERVER default port is 8880.

NETWORK_DEPLOYMENT default port is 8879.


Application name.



Advanced


Password for connecting to WebSphere Application Server. Required only if connection security is enabled.


User name for connecting to WebSphere Application Server. Required only if connection security is enabled.

• Host ( String )






Output Values None



WAS - Update Application This action updates an installed application.

Input Values

Mandatory




Application name.

• Port

Port number as defined on server under SOAP_CONNECTOR_ADDRESS:

STANDALONE_SERVER default port is 8880.

NETWORK_DEPLOYMENT default port is 8879.

• Ear file path

Full path to Java EAR file, which should be accessible from Serena agent host.

Advanced



• Host ( String )




• Options ( String )

Additional installation options. Options format is Python list of strings.

Use a single quote character (') to specify strings, for example, ['-preCompileJSPs', '-filepermission','.*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755'].

For more details about installation options, see IBM documentation for 'AdminApp' object.


User name for connecting to WebSphere Application Server. Required only if connection security is enabled.

WebSphere Actions



Password for connecting to WebSphere Application Server. Required only if connection security is enabled.

Output Values None


Chapter 4

Comparison Actions

In This Chapter

Compare Two Arrays ..................................................................................................................................... 165 Compare Two Booleans ................................................................................................................................. 166 Compare Two Dates ...................................................................................................................................... 167 Compare Two File Checksums ...................................................................................................................... 168 Compare Two Folders.................................................................................................................................... 169 Compare Two Numbers ................................................................................................................................. 171 Compare Two Strings .................................................................................................................................... 172 Compare Two Values .................................................................................................................................... 173

Compare Two Arrays This action compares two arrays of any object, as if they are strings. All non string elements of the arrays are converted to strings prior to comparison.

Input Values

Mandatory

• First Array ( Object[] )

First array to compare.

• Second Array ( Object[] )

Second array to compare.

Advanced

• Ignore Case ( Boolean )

Whether to ignore the case. True for ignore, False for not.

• Expect To Be Equal ( Boolean )

Whether to expect the two arrays to be equal. True for equal, False for not equal.

Output Values None

Chapter 4 Comparison Actions


Compare Two Booleans This action checks whether two specified Boolean arguments are equal.

Input Values

Mandatory

• First Value ( Boolean )

First value to compare.

• Second Value ( Boolean )

Second value to compare.

Output Values None

Compare Two Dates


Compare Two Dates This action compares two specified dates given in yyyy/MM/dd HH:mm:ss format, for example, 2007/06/28 20:30:55.

Input Values

Mandatory

• First Value ( String )

First number value to compare.

• Second Value ( String )

Second number value to compare.

Advanced

• Operator ( ComparisonOp )

Expected comparison operator.

Output Values None



Compare Two File Checksums This action checks the checksum of two files and compares them.

Input Values

Mandatory

• First File Path ( String )

First file path.

• Second File Path ( String )

Second file path.

Advanced

• Should The Checksums Match ( Boolean )

Whether the checksums should match. This affects the result of the action.

Output Values • First File Checksum ( String )

First file checksum.

• Second File Checksum ( String )

Second file checksum.

• Result Of Comparison ( Boolean )

Result of the comparison.

Compare Two Folders


Compare Two Folders This action compares two folders.

Input Values

Mandatory

• First Folder Path ( String )

First folder path.

• Second Folder Path ( String )

Second folder path.

Advanced

• Comparison Report Path ( String )

Comparison report path.

• Exclude Filters ( String )

Filters to exclude folders.

• Folders Comparison Strategy ( FoldersComparisonStrategy )

Comparison strategy to choose (whether to consider extra files on the compared folders).

• Include Filters ( String )

Filters to include folders.

• Include Ok Status In Report ( Boolean )

Whether to include an OK status in the report.

• Should The Folders Match ( Boolean )

Whether the folders should match. This affects the result of the action.

• Filters Separator ( String )

Character to use as the filters separator.

Output Values • Diff Files In First Folder ( String[] )

Result of the comparison, the different file paths in the first folder.

• Diff Files In Second Folder ( String[] )

Result of the comparison, the different file paths in the second folder.

• Missing Files In First Folder ( String[] )



Result of the comparison. The missing file paths in the first folder are displayed.

• Missing Files In Second Folder ( String[] )

Result of the comparison. The missing file paths in the second folder are displayed.

• Result Of Comparison ( String )


Compare Two Numbers


Compare Two Numbers This action compares two specified numbers.

Input Values

Mandatory

• Second Value ( Double )

Second number value to compare.

• First Value ( Double )

First number value to compare.

Advanced


Expected comparison operator.

Output Values None



Compare Two Strings This action checks whether two specified strings are equal.

Input Values

Mandatory

• First String ( String )

First string value to compare.

• Second String ( String )

Second string value to compare.

Advanced


Whether to ignore the case.

• Should Be Equal ( Boolean )

Whether to expect the string to be equal.

Output Values None

Compare Two Values


Compare Two Values This action compares two values, for example, to check if two parameters are equal.

Input Values

Mandatory

• First Value ( Object )

First value to compare. Should be set from Parameter.

• Second Value ( Object )

Second value to compare. Should be set from Parameter.

Output Values None


Chapter 5

Control Actions

In This Chapter

Delay ............................................................................................................................................................. 175 User Input - Stop for Manual Operation .......................................................................................................... 176 Wait For Manual Restart ................................................................................................................................ 177

Delay This action creates a delay for the specified amount of time.

Input Values

Advanced

• Result Description ( String )

Description of the result that is reported for this action.

• Time Unit ( TimeUnit )

Time unit to use, MILLISECONDS, SECONDS and so on.

• Time For Delay ( Long )

Amount of time to delay.

• Expected Result ( Boolean )

Result of this action after the time has elapsed, True for pass, False for fail.

Output Values None

Chapter 5 Control Actions


User Input - Stop for Manual Operation This action displays instructions for some manual operation to be performed by the user.

Once completed, the user indicates whether the operation was performed successfully by clicking the appropriate button.

Input Values

Mandatory

• Operation Description ( String )

Description of the operation to be displayed. This field will display the string in an HTML container.

Advanced

• Failure Message ( String )

Message to be displayed when the manual operation fails.

• Success Label ( String )

Label that will constitute the text displayed in the button to be clicked when the operation is completed successfully.

• Success Message ( String )

Message to be displayed when the manual operation is completed successfully.

• Failure Label ( String )

Label that will constitute the text displayed in the button to be clicked when the operation fails.

Output Values

None

Wait For Manual Restart


Wait For Manual Restart This action will put the agent it runs on into a safe state, so the agent service or the host can be restarted.

Note: To continue the process after this action has finished, the agent service needs to be restarted.

Input Values None

Output Values None


Chapter 6

Database Actions

In This Chapter

Execute SQL Query on IBM DB2 Server ........................................................................................................ 179 Execute SQL Query on Microsoft(c) SQL Server ............................................................................................ 182 Execute SQL Query on MySQL ...................................................................................................................... 184 Execute SQL Query on Oracle(c) Database Server ........................................................................................ 186 Execute SQL Query on Sybase Database Server ........................................................................................... 188 Test DSN Connection .................................................................................................................................... 190

Execute SQL Query on IBM DB2 Server This action executes any type of SQL query on an IBM DB2 server.

Input Values

Mandatory

• User Password ( Password )

Database user password.


Database name to which to connect.


Database server name.

• User Name ( String )

Database user name.

• SQL Query To Execute ( String )

SQL query to execute.

Advanced

• Connection String ( String )

Advanced Option. The database driver connection string should be specified if the driver class name was specified.

• Expected Number Of Affected Lines ( Integer )

Chapter 6 Database Actions


Use this input to verify the success of the query by comparing the expected number to the actual number of affected lines. If the number of affected lines is different than expected, the action will fail. Leave blank if not needed.

• Server Port ( int )

Database server port name.

• Driver Class Name ( String )

Advanced option. The class name of the database driver.

• Properties ( String[ ] )

Advanced Option. Additional properties to pass to the database driver. Should be specified as an array of key=value pairs. '=' is compulsory.

• Batch Mode Separator ( String )

Advanced option. If Batch Mode is selected, then the supplied SQL Query is split by this separator and the resulting strings are run in batch mode.

• Results To Csv Full Path ( String )

Full path of the file in which to save results. The file is in CSV format. This is relevant only if the operation is a select query.

• Is Update ( Boolean )

Set this input to True for UPDATE, INSERT or DELETE queries, otherwise set this input to False.

• Ignore Errors During Batch Mode ( Boolean )

Advanced option. Whether to ignore errors during the execution of commands in Batch Mode.

• Batch mode ( String )

Advanced option. Whether to handle the SQL query supplied in Batch Mode.

Note: Batch Mode is available in UPDATE mode only.

Output Values • Number Of Actual Affected Lines ( int )

Number of lines that were affected by the SQL Query.

• Last Batch Command Number Of Actual Affected Lines ( int )

Number of lines that were affected by the last SQL query command in Batch Mode. (If not in Batch Mode, then this is the same as the Number Of Actual Affected Lines).

• Result Set ( Object[ ][ ] )

Results are displayed in a two dimensional array (Object[][]); the first dimension is the columns and the second dimension is the rows.

Execute SQL Query on IBM DB2 Server


• Result Is Empty ( Boolean )

Whether the result set is empty.



Execute SQL Query on Microsoft(c) SQL Server This action executes any type of SQL on Microsoft© SQL Server.

Input Values

Mandatory

• SQL Query To Execute

SQL Query to execute.

• User Name

Database user name.

• User Password


• Server Name


• Database Name

Database name to connect to.

Advanced


Full path of the file to save results into, the file will be in a CSV format. This is relevant only if the operation is select query.

• Properties ( String[] )

Additional properties to pass to database driver. Should be specified as array of key=value pairs. The equal sign ('=') is compulsory.


Whether to ignore errors during execution of commands in batch mode.


Use this input to verify the success of the query, by comparing expected number of affected lines, to the actual affected lines. If the affected number of lines is different than expected. the step will fail. Leave blank if not needed.

• Batch Mode ( Boolean )

Whether to handle the given SQL query in batch mode.

NOTE: Batch Mode is available in UPDATE mode only.

Execute SQL Query on Microsoft(c) SQL Server



Database driver class name/


Set this input to True in case of UPDATE, INSERT or DELETE queries, otherwise set to False.

• Use Windows Authentication ( Boolean )

Whether to use Windows authentication to log to the server, when set to True. Refer to Serena documentation for more information.


Database driver connection string. Should be specified if Driver Class Name was specified.


If batch mode is selected then the supplied SQL Query will be split by this separator and resulting strings will be run in batch mode.



Output Values • Result Set ( Object[][] )

Results in a two-dimensional array (Object[][]). The first dimension is the columns and the second is the rows.


Number of lines that were affected by the last SQL Query command in batch mode. If not in batch mode, then this is the same as Number Of Actual Affected Lines.

• Number Of Actual Affected Lines ( int )



Whether result set was empty.



Execute SQL Query on MySQL This step executes any type of SQL on MySQL database server.

Input Values

Mandatory

• User Password




• Database Name


• Server Name


• User Name

Database user name.

Advanced


Additional properties to pass to database driver. Should be specified as array of key=value pairs. Equal sign ('=') is compulsory.




Database driver connection string. should be specified if driver class name was specified.


Use this input to verify the success of the query, by comparing expected number of affected lines, to the actual affected lines. If the affected number of lines is different than expected the step will fail. Leave blank if not needed.


If batch mode is selected then the supplied SQL Query will be split by this separator and resulting strings will be run in batch mode.


Execute SQL Query on MySQL


Full path of the file in which to save results. The file will be in a CSV format. This is relevant only if the operation is select query.


Whether to handle the given SQL query in batch mode.

NOTE: Batch Mode is available in UPDATE mode only.






Database driver class name.

Output Values • Last Batch Command Number Of Actual Affected Lines ( int )


• Result Set ( Object[][] )

Results in a two-dimensional array ( Object[][] ). The first dimension is the columns and the second is the rows.







Execute SQL Query on Oracle(c) Database Server This step executes any type of SQL on Oracle© Database Server.

Input Values

Mandatory

• User Password




• User Name

Database user name.

• Server Name

Database server name

• Sid

SID of database to connect to.

Advanced




Additional properties to pass to database driver. Should be specified as array of key=value pairs. '=' is compulsory






Database driver connection string. should be specified if driver class name was specified.


Use this input to verify the success of the query, by comparing expected number of affected lines, to the actual affected lines. If the affected number of lines is different than expected the action will fail. Leave blank if not needed.

Execute SQL Query on Oracle(c) Database Server





If batch mode is selected, then the supplied SQL Query will be split by this separator and the resulting strings will be run in batch mode.


Advanced Option. Indicates whether to handle the SQL query supplied in batch mode, NOTE: batch mode is available in UPDATE mode only.

Results To Csv Full Path ( String )

Full path of the file in which to save results. The file will be in a CSV format. This is relevant only if the operation is select query

Output Values






Results in a two-dimensional array ( Object[][] ). The first dimension is the columns and the second is the rows.



Execute SQL Query on Sybase Database Server This action executes any type of SQL on Sybase Database Server.

Input Values

Mandatory

• Server Name


• Database Name


• User Name

Database user name.

• User Password




Advanced




Additional properties to pass to database driver. Should be specified as array of <key=value> pairs. The equal sign ('=') is mandatory.


Use this input to verify the success of the query, by comparing expected number of affected lines, to the actual affected lines. If the affected number of lines is different than expected, the step will fail. Leave blank if not needed.


Full path of the file to save results into, the file will be in a CSV format. Results to Csv Full Path is relevant only if the operation is select query.


Database server port name. Default value is 5000.


The database driver connection string. should be specified if driver class name was specified.

Execute SQL Query on Sybase Database Server



Whether to ignore errors during execution of commands in batch mode. Default value is False.


If batch mode is selected, the supplied SQL Query will be split by this separator and resulting strings will be run in batch mode. Default value is GO.


Set this input to True in case of CREATE TABLE, UPDATE, INSERT or DELETE queries, otherwise set to False. Default value is False.


Whether to handle the SQL query supplied in batch mode. Note: Batch mode is available in UPDATE mode only. Default value is False.

Output Values • Result Is Empty ( Boolean )





Number of lines that were affected by the last SQL Query command in batch mode.

Note: If not in batch mode, the Last Batch Command Number of Actual Affected Lines is the same as Number Of Actual Affected Lines.


Results in a 2 dimensions array (Object[][]). The first dimension is the columns and the second is the rows.



Test DSN Connection This action tests a predefined DSN connection.

If a user name and password are not specified, NT authentication will be performed based on the identity of the agent that actually executes the action.

Input Values

Mandatory

• DS Name ( String )

DSN connection to test.

Advanced

• User Pass ( String )

Password to use.


User name to use.

Output Values None


Chapter 7

Email Action

In This Chapter

Send Email .................................................................................................................................................... 191

Send Email This action sends an email according to the specified properties.

Input Values

Mandatory

• Send To

List of the targets of the email (the To field).

• Smtp Mail Server

Outgoing mail server address (e.g. smtp.somewhere.com).

Advanced

• Attachments Paths ( String[] )

List of full paths to the locations of the attachments to use.

• Smtp User Name ( String )

Outgoing mail server user name to use.

• Send CC ( String[] )

List of the CC targets of the email (the CC field).

• Body ( String )

Body of the mail.

• Subject ( String )

Subject of the mail.

• Body Type ( String )

Type of the body contents can be either 'text/html' or 'text/plain'.

Chapter 7 Email Action


• Send BCC ( String[] )

List of the BCC targets of the email (the BCC field).

• Smtp User Password ( String )

Outgoing mail server user password to use.

• From ( String )

From address to use.

• Server requires Authentication ( Boolean )

Whether the server requires authentication.

Output Values None


Chapter 8

F5BigIP Actions

In This Chapter

F5 - Add Member to Pool ............................................................................................................................... 193 F5 - Change Pool Member's Settings ............................................................................................................. 195 F5 - Create Pool ............................................................................................................................................ 197 F5 - Delete Pool ............................................................................................................................................. 198 F5 - Disable iRule .......................................................................................................................................... 199 F5 - Disable Member ..................................................................................................................................... 200 F5 - Enable iRule ........................................................................................................................................... 201 F5 - Enable Member ...................................................................................................................................... 202 F5 - List All Pool Members ............................................................................................................................. 203 F5 - List All Pools ........................................................................................................................................... 204 F5 - Remove Member From Pool ................................................................................................................... 205

F5 - Add Member to Pool This action adds a new member to the specified pool for F5 BIG-IP.

Input Values

Mandatory

• F5 User Name

Login name to the F5 management console.

• F5 Mngmnt IP

IP address of the F5 BigIP management console.

• Pool Name

Name of the pool.

• Member Address

IP address of a new pool member.

• F5 Password

Password to login the F5 management console.

• F5 User Name

Chapter 8 F5BigIP Actions



• Member Port

Port of a new pool member.

Advanced

• Partition Name ( String )

Name of the active partition.

• F5 Mngmnt Port ( Integer )

Port to the F5 BigIP management console.

Output Values None

F5 - Change Pool Member's Settings


F5 - Change Pool Member's Settings This action enables the changing a pool member's ratio, priority group, and connection limit for F5 BIG-IP.

Input Values

Mandatory

• Member Port

Port of the pool member.

• F5 User Name


• F5 Password

Password to log on to the F5 management console.

• Pool Name

Name of the pool.

• Member Address

IP address of the pool member.

• F5 Mngmnt IP


Advanced



• Connection Limit ( Long )

New pool member connection limit. Should be an integer within the range of 0 to 45645656456.



• Ratio ( Integer )

New pool member ratio value. Should be an integer within the range of 1 to 100.

• Priority Group ( Integer )

New pool member priority group. Should be an integer within the range of 0 to 65535.



Output Values None

F5 - Create Pool


F5 - Create Pool This action creates new pool for F5 BIG-IP.

Input Values

Mandatory

• LB Method

Name of the load balancing method.

• Pool Name

Name of the pool.

• F5 User Name


• F5 Password

Password to login the F5 management console

• F5 Mngmnt IP


Advanced



• Initial Address ( String )

IP address of the initial pool member.



• Initial Port ( Integer )

Port of the initial pool member.

Output Values None



F5 - Delete Pool This action deletes the specified pool from F5 BIG-IP.

Input Values

Mandatory

• Pool Name

Name of the pool.

• F5 Password


• F5 Mngmnt IP


• F5 User Name


Advanced





Output Values None

F5 - Disable iRule


F5 - Disable iRule This action disables the requested iRule.

Input Values

Mandatory

• F5 User Name


• F5 Password


• IRule name

IRule name.

• Virtual Server Port

Virtual Server's service port.

• Virtual Server Name

Virtual Server's name.

• Virtual Server Destination Host

Virtual Server's destination host.

• F5 Mngmnt IP


• Fail If Already Disabled

Fail action if the specified iRule already disabled.

Advanced





Output Values None



F5 - Disable Member This action sets the monitor state of the specified member to Disabled.

Input Values

Mandatory

• F5 Password


• Pool Name

Name of the pool.

• Member Address


• F5 User Name


• Member Port


• F5 Mngmnt IP


Advanced


Name of the active partition



Output Values None

None

F5 - Enable iRule


F5 - Enable iRule This action enables the requested rule.

Input Values

Mandatory

• Virtual Server Port

Virtual Server's service port.

• Virtual Server Name

Virtual Server's name.

• F5 Password


• IRule name

IRule name.

• F5 Mngmnt IP


• F5 User Name


• Fail If Already Enabled

Fail action if the specified iRule already enabled.

• Virtual Server Destination Host

Virtual Server's destination host.

Advanced





Output Values None



F5 - Enable Member This action sets the monitor state of the specified member to Enabled.

Input Values

Mandatory

• Pool Name

Name of the pool.

• F5 User Name


• Member Address


• F5 Password


• Member Port


• F5 Mngmnt IP


Advanced





Output Values None

F5 - List All Pool Members


F5 - List All Pool Members This action enumerates members of the specified pool for F5 BIG-IP.

Input Values

Mandatory

• F5 User Name


• Pool Name

Name of the pool.

• F5 Mngmnt IP


• F5 Password


Advanced





Output Values • Member Addresses ( String[] )

IP addresses of pool members.

• Member Ports ( Integer[] )

Ports of pool members.



F5 - List All Pools This action enumerates all pools for F5 BIG-IP.

Input Values

Mandatory

• F5 User Name


• F5 Mngmnt IP


• F5 Password


Advanced





Output Values • Pool Names ( String[] )

List containing names of pools.

F5 - Remove Member From Pool


F5 - Remove Member From Pool This action removes the specified member from the specified pool for F5 BIG-IP.

Input Values

Mandatory

• F5 Mngmnt IP


• F5 Password


• F5 User Name


• Member Address

IP address of pool member.

Member Port

Port of pool member.

• Pool Name

Name of the pool.

Advanced





Output Values None


Chapter 9

File / Folder Actions

In This Chapter

Add Text to a File ........................................................................................................................................... 208 Change Mode of File or Folder ....................................................................................................................... 210 Change Owner of File or Folder ..................................................................................................................... 211 Change Read Only Mode of File or Folder ..................................................................................................... 212 Check if File or Folder Exists .......................................................................................................................... 213 Check if Specific User has Permissions on File or Folder ............................................................................... 214 Compare Two File Checksums ...................................................................................................................... 215 Compare Two Folders.................................................................................................................................... 216 Copy File or Folder with Backup ..................................................................................................................... 218 Copy File(s) or Folder(s) ................................................................................................................................ 219 Copy Single File or Folder .............................................................................................................................. 220 Create a Symbolic Link .................................................................................................................................. 221 Create Empty File .......................................................................................................................................... 222 Create Folder ................................................................................................................................................. 223 Create ZIP File............................................................................................................................................... 224 Delete File ..................................................................................................................................................... 225 Delete File or Folder ...................................................................................................................................... 226 Delete Folder ................................................................................................................................................. 227 Download File (FTP Server/Network Drive) .................................................................................................... 228 Download File (HTTP).................................................................................................................................... 229 Extract Text from a File .................................................................................................................................. 231 Extract ZIP ..................................................................................................................................................... 232 Find Files or Folders ...................................................................................................................................... 233 Find Text in File ............................................................................................................................................. 235 Get File (SSH) ............................................................................................................................................... 237 Get File Checksum ........................................................................................................................................ 238 Get File Details .............................................................................................................................................. 239 Get File or Folder from Remote Agent ............................................................................................................ 240 Get File Properties ......................................................................................................................................... 242 Get Value from an INI file ............................................................................................................................... 242 Log to File on Serena Center ......................................................................................................................... 244 Manipulate INI File ......................................................................................................................................... 245 Move File or Folder ........................................................................................................................................ 246 Put File or Folder in Remote Agent ................................................................................................................ 247 Read String Array from Text File .................................................................................................................... 249 Read String from Text File ............................................................................................................................. 250 Rename File or Folder ................................................................................................................................... 251

Chapter 9 File / Folder Actions


Replace Text in File ....................................................................................................................................... 252 Replace Text in Multiple Files......................................................................................................................... 253 Synchronize Two Folders ............................................................................................................................... 254 Update Value in Array (String)........................................................................................................................ 256 Write Array to Text File .................................................................................................................................. 257 ZIP Many Files ............................................................................................................................................... 258

Add Text to a File This action inserts text into a file.

It is possible to specify text that is to be searched in the file, and the Text To Add input will be added after it.

If no search text is specified, the text is added at the end of the file.

Input Values

Mandatory

• File Path ( String )

Path to the file in which the text is to be added.

• Text To Add ( String )

Text that is to be added. Can set the explicit value, or use one of the string parameters, except for the String Array Parameter.

Advanced

• Add With New Line ( Boolean )

Whether to add the text with a New Line character.

• Is Regex ( Boolean )

Whether to treat Add After This Text as a regular expression.

• Add After This Text ( String )

Specified text to search for in the file, after which the specified Text To Add input is added.

• Add Text At The Beginning ( Boolean )

Whether to add the text at the beginning. It is True for the beginning, and False for the end. It is relevant only if Add After This Text is empty.

• Create File If Not Exist ( Boolean )

Create the file if it does not exist.

Add Text to a File


Output Values None



Change Mode of File or Folder This action performs a change mode operation on the specified file or folder. This action supports Unix/Linux systems only.

Input Values

Mandatory

• Mode ( int )

Mode number to which to change the file or folder. Refer to the Unix/Linux 'chmod' command for more details.

• File Or Folder Path ( String )

Path to the file or folder on which to change the mode. Can set explicit values or use the File parameter.

Advanced

• Change Recursively ( Boolean )

Whether to apply the changed mode recursively on a folder, included files and sub-folders.

Fail If Does Not Exist ( Boolean )

Whether to return false if the path is invalid.

Output Values None

Change Owner of File or Folder


Change Owner of File or Folder This action changes the owner of the specified file or folder. This action will work on Linux or UNIX systems only.

Input Values

Mandatory

• File Name ( String )

Path to the file or folder to change its owner.

• New Owner ( String )

New owner user name.

Advanced

• Fail If Not Exists ( Boolean )

Specifies what to do if the specified file or folder does not exist.


If the resource is not a Folder, it indicates whether to change the ownership recursively.

Output Values None



Change Read Only Mode of File or Folder This action sets the read-only flag on a file or folder.

Input Values

Mandatory


Path to the file or folder on which to set the read-only flag.

Advanced

• Read-Only Mode ( Boolean )

Sets or unsets the read-only flag of the file or folder. True to set, False to unset.


What to do if the file or folder does not exist, True to fail, False to ignore.


If the resource is a Folder, it indicates whether to change the read-only flag recursively.

Output Values None

Check if File or Folder Exists


Check if File or Folder Exists This action checks if the specified file or folder exists in the file system.

Input Values

Mandatory


Path to the file or folder to check if exists. Can set explicit values or use the File parameter. Wildcard * can also be used.

Advanced


Whether to expect the file or folder to exist. True for exist, False for not exist.

Output Values None



Check if Specific User has Permissions on File or Folder This action checks if the specified user credentials has the specified permissions on the specified file or folder.

On Windows systems using the domain, specify the domain name with the user name, for example: DOMAIN\Username.

On non-windows systems using the domain, there is no need to specify the domain name.

Note: On Microsoft OS, it supports only Windows XP and above.

Input Values

Mandatory


User name on which to verify permissions. Refer to the Actions Reference help for more details.


Path to the file or folder to check. Can set explicit values or use the File parameter.

• Password ( String )

User password on which to verify permissions. Refer to the Action Reference help for more details.

Advanced

• Can Exec ( Boolean )

Check if the specified user has execution permissions for the file or folder.

• Can Read ( Boolean )

Check if the specified user has read permissions for the file or folder.

• Can Write ( Boolean )

Check if the specified user has write permissions for the file or folder.

Output Values None

Compare Two File Checksums


Compare Two File Checksums This action checks the checksum of two files and compares them.

Input Values

Mandatory


First file path.


Second file path.

Advanced











Compare Two Folders This action compares two folders.

Input Values

Mandatory

• First Folder Path ( String )

First folder path.

• Second Folder Path ( String )

Second folder path.

Advanced

• Comparison Report Path ( String )

Comparison report path.


Filters to exclude folders.


Comparison strategy to choose (whether to consider extra files on the compared folders).


Filters to include folders.

• Include Ok Status In Report ( Boolean )

Whether to include an OK status in the report.

• Should The Folders Match ( Boolean )

Whether the folders should match. This affects the result of the action.


Character to use as the filters separator.

Output Values • Diff Files In First Folder ( String[] )

Result of the comparison, the different file paths in the first folder.

• Diff Files In Second Folder ( String[] )

Result of the comparison, the different file paths in the second folder.

• Missing Files In First Folder ( String[] )

Compare Two Folders


Result of the comparison. The missing file paths in the first folder are displayed.

• Missing Files In Second Folder ( String[] )

Result of the comparison. The missing file paths in the second folder are displayed.

• Result Of Comparison ( String )




Copy File or Folder with Backup This action copies the specified file or folder from the source path to the target path. All files that are overwritten in the target path are saved in the folder specified by the backup path input. If this folder does not exist, it will be created.

Input Values

Mandatory

• Backup Path ( String )

Path of backup files. Can set explicit values or use the File parameter.

• Target Path ( String )

Path of the target file or folder.

• Source Path ( String )

Path of the source file or folder. Can set explicit values or use the File parameter.

Output Values None

Copy File(s) or Folder(s)


Copy File(s) or Folder(s) This action copies the specified file(s) or folder(s) from the source path into the target folder.

Input Values

Mandatory

• Is Regular Expression

Whether the expression that the user has entered is a regular expression (java Regex).

• Target Parent Folder

Path of the folder into the file(s), or folder(s), will be copied.

• Source Path or expression

Path of the source file(s) or folder(s).

• Overwrite

Whether to overwrite a file if it already exists in the target location.

Advanced

• Preserve Permissions ( Boolean )

Whether to preserve file permissions and owner information.

Output Values • Failed File Names ( String[] )

Array containing names of files that could not be copied.

If many files could not be copied, list may be partial.



Copy Single File or Folder This action copies the specified file or folder from the source path to the target path.

Input Values

Mandatory

• Source Path

Path of the source file or folder. Explicit values can be set or use a File Parameter to pre-set the value.

• Target Path

Path of the target file or folder.

Output Values None

Create a Symbolic Link


Create a Symbolic Link This action creates a symbolic link on Unix/Linux machines.

Input Values

Mandatory

• Target Path

Full path of the target, that is, the path of entity to which the symbolic link will refer.

• Symbolic Link Path

Full path of the symbolic link to create.

Advanced

None

Output Values None



Create Empty File This action creates an empty file by a given path.

Input Values

Mandatory

• Full Path

Full path of the file to create.

Advanced

• Fail If Exist ( Boolean )

By default, if the file already exists, the action will fail. Set to false to override this behavior.

• Create Parent Path ( Boolean )

Set to false to prevent creating a parent folder.

Output Values None

Create Folder


Create Folder This action creates a folder on the file system. The full path of the specified folder is created.

Input Values

Mandatory

• New Folder Path ( String )

Full path to the folder that is to be created.

Advanced


By default, if the folder already exists, the action will not fail. Set to True to override this behavior.

Output Values None



Create ZIP File This action creates the specified ZIP file from the source path. The source path is expected to exist.

Input Values

Mandatory

• Source Path ( String[] )

Path to the source from where the contents of the ZIP file is to be created.

• Zip File Path ( String )

Path to where the ZIP file is to be created.

Advanced

• Directory Exclude Filter ( String )

The filter to use for excluding directories. If a Directory's path matches this pattern, it will NOT be included in archive. Important Note: This filter tests against the path relative to Source Path.

• Files Exclude Filter ( String )

Filter to use to exclude files. Files that match this pattern will NOT be included in archive.

• Files Filter ( String )

Filter to use to filter files. Only files that match this pattern will be included in archive.

• Regular Expression Filter ( Boolean )

Whether Files Filter, Files Exclude Filter, and /or Directory Exclude Filter are regular expressions. Default value is False.

• Include Sub Folders ( Boolean )

Whether to include sub-folders. Empty folders would also be included. The default is True.

• Include Root Folder ( Boolean )

Whether to include the root folder. The zip file will start with this folder. Default value is True.

Output Values None

Delete File


Delete File This action deletes a file on the file system.

Input Values

Mandatory


Path to the file to delete.

Advanced

• Fail If Not Exist ( Boolean )

Whether to fail if the path does not exist: True to fail, False to ignore.

Output Values None



Delete File or Folder This action deletes the specified file or folder. You can choose whether to delete recursively and whether to delete folders.

This action is not case sensitive on Windows.

Input Values

Mandatory

• File/Folder Path ( String )

Full Path of the file or folder to delete.

• Is Regular Expression ( Boolean )

Whether the expression that the user has entered is a regular expression(java Regex).

• Delete Recursive ( Boolean )

Delete files recursively, including files in subfolders.

• Delete Folders ( Boolean )

Whether to delete folders or not. If set to True, only files will be deleted and folders will remain empty.

• Fail If Not Empty ( Boolean )

Whether to fail if the folder is not empty or to delete its content, True to fail, False to delete its content.


Whether to fail if the path does not exist, True to fail, False to ignore.

Output Values None

Delete Folder


Delete Folder This action deletes a folder on the file system.

Input Values

Mandatory

• Folder Path ( String )

Path to the folder to delete.

Advanced

• Fail If Not Empty ( Boolean )

Whether to fail if the folder is not empty or to delete its content, True to fail, False to delete its content.


Whether to fail if the path does not exist, True to fail, False to ignore.

Output Values None



Download File (FTP Server/Network Drive) This action downloads a file from a remote ftp server or network drive to a specified location.

You can embed username and password for the ftp server in the URL, for example, "ftp://userid:password@ftp-server/file".

Credentials for shared directories should be supplied via User Name and Password input parameters.

Input Values

Mandatory

• Source URL

URL of the remote file to download. You can embed the username and password for the FTP server in the URL, for example, "ftp://userid:password@ftp-server/file".

• Destination Path

Full path and file name of the location to download the file to.

Advanced


Optional password to use; not relevant for FTP/FTPS.


Whether to fail if the path does not exist: True to fail, False to ignore.


Optional user name to use; not relevant for FTP/FTPS

Output Values None

Download File (HTTP)


Download File (HTTP) This action downloads a file from a specified URL using HTTP/S.

Input Values

Mandatory

• Url

HTTP or HTTPS URL to access.

• Destination File Path

Destination path for the downloaded file.

Advanced

• Use Preemptive Authentication ( Boolean )

Whether to use Preemptive Authentication when using user name to login to the Web site.


User name for authentication. Only relevant if Authentication Method is NOT "NONE".

• Realm ( String )

Realm that authenticates the user. Only relevant if Authentication Method is "BASIC" or "DIGEST".

• Expected Code ( Integer )

Expected HTTP return code. Action will fail if expected code is not returned. If left empty, any return code in the range 200-299 is acceptable.

• Authentication Method ( AuthMethod )

Methods used to authenticate with HTTP servers or proxies: Basic, Digest or NTLM. "NONE" means no authentication is required.

• Connection Timeout (seconds) ( Integer )

Time in seconds in which a connection should be established. Default value is one (1) minute. A value of zero (0) means the timeout is not used.

• Read Timeout (seconds) ( Integer )

Default socket timeout in seconds to wait for data. A timeout value of zero (0) is interpreted as an infinite timeout.


User password. Only relevant if Authentication Method is NOT "NONE".

• Domain ( String )

Server domain. Only relevant if Authentication Method is NOT "NONE".



Output Values • HTTP Response Code ( int )

HTTP return code. If no HTTP connection could be made, -1 will be returned,

Extract Text from a File


Extract Text from a File This action extracts text from a given file by a given regular expression and stores found matched groups as defined by the result template input. The extraction result should be stored as a String Parameter.

For example: If the regular expression is "url=http://(server\d)/(path\d)",

the result template is "$2 on $1", and the file contains the line "url=http://server8/path5",

the extraction result will be "path5 on server8".

Refer to http://www.regular-expressions.info/ for more details.

Input Values

Mandatory

• Regular Expression ( String )

Text to find in the file. To search using regular expression placeholders, use the standard regular expression conventions. See http://www.regular-expressions.info for more details about regular expressions syntax.

• Filename ( String )

File from which text is to be extracted.

Advanced

• Result Template ( String )

Template for the extraction result. Use $n for group n in the regular expression input. Refer to the Actions Reference help for an example. To get character $ type \$.

Output Values • Extraction Result ( String )

Result of the extraction operation.



Extract ZIP This action extracts the specified ZIP file to the destination path. The destination path is expected to exist.

Note: The destination path must exist.

Input Values

Mandatory

• Zip File Path ( String )

Path to the ZIP file to be extracted.

• Destination Path ( String )

Path to the directory in which the contents of the ZIP file will be extracted.

Output Values None

Find Files or Folders


Find Files or Folders This action returns the paths of files or folders that match the wildcard.

Input Values

Mandatory

• Root Folder Path ( String )

Path of the folder from where to start the search.

• Name Format ( String )

Pattern of names to search for. The pattern can contain common wild card characters:

? is a wild card and replaces any single character.

* is a wild card and replaces any string of characters.

Advanced

• Find Recursively ( Boolean )

Whether to search the specified pattern recursively (that is, in all directories beneath the Root Folder Path) or only in the root folder:

True (default) - Perform a recursive search.

False - Search only in the root folder.

• Sort By Type ( Boolean )

Whether to sort the found entries by their file extension:

True - Sort the entries in ascending order. If this sort is set, it is performed after the Name sort.

• After Date ( String )

Date is specified in the format of yyyy/MM/dd HH:mm:ss. Files that were last modified before the specified date, will not appear in the result.

• Files Or Folders ( Boolean )

Whether to search for files or for folders:

True (default) - Search for names of files.

False - Search for names of folders.

• Return Full Path ( Boolean )

Whether to return the file name along with the full path. You may encounter duplication if there are files with the same name in different directories.




Whether to ignore the case of the file names:

True - Perform a case-insensitive search.

False (default) - Perform a case-sensitive search.

• Sort By Name ( Boolean )

Whether to sort the found entries by their file extension:

True - Sort the entries in ascending order. If this sort is set, it is performed after the last modified sort.

• Sort By Last Modified ( Boolean )

Whether to sort the found entries by their last modified date:

True - Sort the entries with the most recent first. If this sort is set, it is performed first.

• Before Date ( String )

Date is specified in the format of yyyy/mm/dd hh:mm:ss. Files that were last modified after the specified date, will not appear in the result.

• Sort By Size ( Boolean )

Whether to sort the found entries by their size on disk:

True - Sort the entries so that the biggest entry is first. If this sort is set, it is performed after the Type sort.

Output Values • First Name Found ( String )

First name found that matches the search pattern. This is for more convenient usage if only one file is expected.

• Was Found ( Boolean )

Flag that will become true if at least one file or folder matches the search pattern.

• Number Of Entries ( int )

Number of files or folders that match the search pattern.

• List Of Found Entries ( String[] )

Array of files or folders that match the search pattern. The full path of the files or folders is shown.

Find Text in File


Find Text in File This action finds a word or a string in the specified text file.

Note: For searches that use regular expressions, the maximum size of a file that can be searched in is 10 MB.

Input Values

Mandatory


Path to the file in which to search.

• Text To Find ( String )

Text to find in the specified file.

To search using regular expressions, set Regular Expression input parameter to True.


Advanced

• Regular Expression ( Boolean )

Whether to search using Regular Expressions. If True, the Text to Find input will be considered as a regular expression.

• File Character Set ( String )

Character set of the target file, if known; for example: Unicode or Windows-1255.

If this value is left blank, the search will first be performed using the system's default character set. If, during this initial search, the searched for text is not found, another attempt will be made using Unicode.

• Case Sensitive ( Boolean )

Whether to consider character case when performing the search:

True - Character case-sensitive when performing the search.

False (default) - Character case-insensitive when performing the search.

• Text Should Exist ( Boolean )

Whether to expect the text to be found or not to be found:

True (default) - It is expected that the text will be found.

False - It is not expected that the text will be found.

• Timeout ( int )



Timeout to wait before failing. Action will retry until success or timeout.

Output Values • Text To Find ( String )

Text to find in the file. To search using Regular Expressions, set Regular Expression input parameter to True.


Get File (SSH)


Get File (SSH) This action retrieves a file from a remote host using SSH/SFTP protocol.

Input Values

Mandatory

• Full Target File Path

Full path of the destination on the local host.

• Host Name

Host name or IP address to which to connect.

• User Name

User name to use when authenticating with the remote host.

• Full Source File Path

Full path of the source file to retrieve from the target host.

Advanced

• Keystore File ( String )

Private key file to use in case password is not used.

• Keystore Password ( String )

Password for private key file, if needed.


Password to use when authenticating with the remote host.

• SSH Port ( int )

Port to use when connecting to the remote host.

Output Values None



Get File Checksum This action generates a checksum of the specified file.

Input Values

Mandatory Inputs


Path to the file for which a checksum is to be generated.

Output Values • File Checksum ( String )


Get File Details


Get File Details This action receives a file name and returns details for it.

Input Values

Mandatory Inputs

• Full File Name

Path to the file to check.

Output Values • Parent Name ( String )

File location.


File name.

• Exist ( Boolean )

Set to True if the file exists, False if not.

• Is Directory ( Boolean )

Set to True if the file is a directory, False if not.



Get File or Folder from Remote Agent This action copies a file or folder from a path on the specified remote agent to the local agent.

• The destination is the full path of the new location, including the name of the file, or folder.

• If the Destination path does not exist, then it is created along with any missing parent folders.

• If the destination path exists, then the action behaves as follows:

If both source and destination are files, then the destination is replaced with the source.

If both source and destination are folders, then the source and destination are merged, with the source taking precedence.

If at any point there is an attempt to replace a file with a folder, or vice versa, then the action will replace the file/folder, unless the Overwrite parameter is set to False.

Input Values

Mandatory Inputs

• Source Path ( String )

Path of the source file, or folder, on the remote machine.

It is advisable to use a forward slash ('/') as the file separator.

• Destination Path ( String )

Full destination path on the local machine, including the name of the file, or folder.

If the destination path does not exist, then it is created along with any missing parent folders. However, if a file is being transferred, Destination Path must include the filename on the local machine.

It is advisable to use a forward slash ('/') as the file separator.

• Remote Agent ( String )

IP address of the remote agent or Agent ID in Serena Communication Network.

Advanced

• Overwrite ( Boolean )

Whether to overwrite file, or folder, if it is already exists in the destination path. If file, or folder, exists and Overwrite is set to False, the action will fail. Default value is True.

• Preserve Unix Mode Permissions ( Boolean )

Whether to preserve the Unix Mode Permissions of the destination. Default value is False.

• File Owner ( String )

Set new Unix file owner and group for the destination:

Get File or Folder from Remote Agent


only owner - for example, 'user1'

only group - for example, ':group1'

owner & group - for example, 'user1:mygroup'

If left empty, an attempt will be made to preserve the owner from the source file or folder.

Default value is the same owner.

Output Values None



Get File Properties This action extracts properties such as the last modified date and the size of specified file.

Input Values

Mandatory


Path to file or folder to extract properties from.

Advanced

• Date Format ( String )

String format to use. The default format is yyyy/MM/dd HH:mm:ss.

Output Values • File Size ( Long )

File size in bytes. For folders, this value is always 0.

• Last Modified Date As String ( String )

Last modified date, as a string. The string format is specified by the Date Format input.

• Last Modified Date As Long ( Long )

Last modified date, as number of milliseconds from 00:00:00 GMT, January 1, 1970.

Get Value from an INI file This action finds a key in a section of an INI file and returns its value. If the INI file, section or key is missing then the action will fail. If the needed key is not in any section the INI Section Name input can be left blank.

Input Values

Mandatory

• INI Key Name

The name of the key to find.

• INI File Path

The path to the INI file.

Advanced

• INI Section Name ( String )

The name of section that contains the key.

Get Value from an INI file


Output Values • INI Key Value ( String )

The current index of the iterations.

Log to File on Serena Center This action allows the user to write a message to a CSV or text file on the Serena Center machine.

The CSV file format is: [time stamp],[agent],[message].

The text file format is: [time stamp]<tab>[agent]<tab>[message].

Input Values

Mandatory

• File Path

Path of a file. If the file does not exist, it will be created.

Advanced

• File Type ( FileType )

File type of log to create.

If the File Type is TXT, the delimiter value is a tab.

If the File Type is CSV, the delimiter value is a comma, which wraps each value, meaning that the last character in the string to output is a comma.

• Message ( String )

Message to be logged.

• Messages array ( String [] )

Array of messages. The array values will be separated by the file delimiter.

Output Values None

Manipulate INI File


Manipulate INI File This action adds or updates an INI file. It is possible to specify a section to which the added or updated keys should belong. If no section is needed, leave the INI Section Name input blank, In addition, set the Section Should Exist input to False.

Input Values

Mandatory

• INI File Path ( String )

Path to the INI file.

• Key Value Array ( String[] )

Array of strings, each having the format "key=value".

Advanced


Name of the INI section that contains the keys.

• Section Should Exist ( Boolean )

Whether to create the specified section if it does not exist. True for ignore, False for create.

• Key Value Separator ( String )

Character used as a separator in each string in the Key Value Array input.

Output Values None



Move File or Folder This action moves the specified file or folder from the source path to the target path.

Note: This action is not case sensitive on Windows.

Input Values

Mandatory

• Is Regular Expression

Whether the expression that the user has entered is regular expression(java Regex).

• Target of File/Folder Path

Target location for the file or folder that you want to move.

• Overwrite

Whether to overwrite file if it already exists the target location.

• Source Path or expression

Path of the source file or folder.

Output Values

None

Put File or Folder in Remote Agent


Put File or Folder in Remote Agent This action copies a file or folder from the local agent to a path on the specified remote agent.

• The destination is the full path of the new location, including the name of the file, or folder.

• If the Destination Path does not exist, then it is created along with any missing parent folders.

• If the Destination Path exists, then the action behaves as follows:

If both source and destination are files, then the destination is replaced with the source.

If both source and destination are folders, then the source and destination are merged with the source taking precedence.

If at any point there is an attempt to replace a file with a folder, or vice versa, then the action will replace the file or folder, unless the Overwrite parameter is set to False.

Input Values

Mandatory


Full destination path on the remote machine, including the name of the file, or folder.

If the destination path does not exist, then it is created along with any missing parent folders. However, if a file is being transferred, Destination Path must include the filename.

Note: It is advisable to use a forward slash ('/') as a file separator.

• Agent IP

IP address of the remote agent.

• Source Path

Path of the source file or folder on the local machine.

It is advisable to use a forward slash ('/') as a file separator.

Advanced


Whether to overwrite a file, or folder, if it is already exists in the destination path. If the file, or folder, exists and Overwrite is set to False, the action will fail. Default value is True.

• Preserve Unix Mode Permissions ( Boolean )

Whether to preserve the Unix Mode Permissions of the destination. Default value is False.

• File Owner ( String )

Set the new Unix file owner and group for the destination:



only owner - for example, 'user1'

only group - for example, ':group1'

owner & group - for example, 'user1:mygroup1'

If left empty, an attempt will be made to preserve the owner from the source file or folder.

Default value is the same owner.

Output Values None

Read String Array from Text File


Read String Array from Text File This action reads a specified text file and inserts every line of the file as an element of a new array.

Input Values

Mandatory


Name of the file to be read.

Output Values • Result Array ( String[] )

Resulting array.



Read String from Text File This action reads a specified text file. This action can be used to read a file's contents into a String Parameter.

Note: The file size should not exceed 100 KB.

Input Values

Mandatory



Output Values • Result String ( String )

Resulting string.

Rename File or Folder


Rename File or Folder This action renames the specified file or folder to the given name. Only one file name can be renamed.

Input Values

Mandatory

• Source File

Path of the target file or folder to rename.

• New File Name

New file name. Should not contain any path and will be created in the original file location.

Output Values None



Replace Text in File This action replaces a string in a text file.

This action will fail if either the specified file does not exist, or if the text was not found.

Note: This action may be performed only on files that are less than 10 MB in size.

Input Values

Mandatory


Text to find in the file. In order to search using regular expressions, set the Is Regular Expression input to True (see below). Refer to http://www.regular-expressions.info for more details.


Path to the file in which text is to be replaced.

• Text To Replace ( String )

Replacement text for all occurrences of the Text To Find input found in the specified file.

Advanced

• File Encoding ( String )

Encoding of the specified file.

• Escape Replacement ( Boolean )

Should be set to False if the replacement text is already escaped in the case of regular expressions.


Whether to search using regular expressions. If this value is set to True, the Text To Find input will be recognized as a regular expression.

Output Values None

Replace Text in Multiple Files


Replace Text in Multiple Files This action replaces a string that may recur in multiple text files. All occurrences of the string are replaced in each file.

Note: This action will fail if even one of the specified files does not exist.


Input Values

Mandatory

• Text to Replace ( String )

Replacement text for all occurrences of the Text To Find input found in the specified files.

• File Paths ( String[] )

Paths to the text files.


Text to find in the specified files. To search using regular expressions, set the Is Regular Expression input to True (see below). For more details, see http://www.regular-expressions.info/.

Advanced





• May Not Contain The Text ( Boolean )

Whether the action should pass or fail if the Text to Find was not found in some of the specified files:

Select True if not all the files must contain the Text to Find.

Select False if all files must contain the Text to Find.



Output Values None



Synchronize Two Folders This action synchronizes two folders. Synchronization is accomplished by copying files from the first folder to the second folder. The copied files are determined according to the chosen strategy.

Note: FULL_COMPARISON and IGNORE_EXTRA_FILES_IN_FIRST will cause extra files or folders in the second folder to be deleted!

Strategy Descriptions

• FULL_COMPARISON = Fully synchronizes both folders. At the end they will be identical.

• IGNORE_EXTRA_FILES_IN_FIRST = New files or folders in the first folder will not be copied to the second folder; extra files in second folder will be deleted.

• IGNORE_EXTRA_FILES_IN_SECOND = New files or folders in the first folder will not be copied to the second folder; extra files in the second folder will not be deleted.

• IGNORE_EXTRA_FILES_IN_BOTH = New files or folders in the first folder will not be copied to the second folder, extra files in the second folder will not be deleted.

Input Values

Mandatory

• Second Folder Path

Second folder path.

• First Folder Path

First folder path.

Advanced


Comparison strategy to use during synchronization. Strategy determines whether to consider extra files on the compared folders or not.

Warning! FULL_COMPARISON and IGNORE_EXTRA_FILES_IN_FIRST will cause extra files or folders in second to be deleted!

• Copy Different Files ( Boolean )

If set to True, files that differ between the two folders will be copied from the first folder to the second. If set to False, files that exist in both folders will not be copied, even if the files differ.


Folder include filters.


Folder exclude filters.

Synchronize Two Folders



Character to use as filters separator.

Output Values • Changed Files List ( String[] )

Changed files list from the first folder.



Update Value in Array (String) This action updates a value in an array using given array index.

Notes:

Index is 1-based index. For first value in array, specify index 1. If the array does not have the index specified, the action will fail.

Array must already exist and cannot be null.

Input Values

Mandatory

• Index

Index of the value to update.

• New Value

New value to set.

• Array

Array on which to perform operation.

Output Values • Array ( String[] )

Array on which operation was performed.

Write Array to Text File


Write Array to Text File This action writes a specified array to a specified file.

Input Values

Mandatory

• Filename

File name to which to write the array.

• Array

Array to be written to the specified file.

Advanced

• Create File If Not Exists ( Boolean )

Whether to create the file, if it does not exist.

• Append ( Boolean )

Set to True to append to file, and False to rewrite the file.

Output Values None



ZIP Many Files This action creates the specified ZIP file from multiple source paths. The source paths are expected to exist.

Input Values

Mandatory

• Source Paths

Path to the source from where the contents of the ZIP file would be created.

• Zip File Path

Path to the ZIP file to be created.

Advanced

• Files Filter ( String )

Filter to use to filter files.

• Include Sub Folders ( Boolean )

Whether to include sub folders. Empty folders are also included.

• Regular Expression Filter ( Boolean )

Whether the files filter is a regular expression.

Output Values None


Chapter 10

Installation Actions

In This Chapter

Check if RPM Package is Installed ................................................................................................................. 259 Execute JavaScript Code ............................................................................................................................... 260 Install RPM Package ...................................................................................................................................... 262 Install Windows Service ................................................................................................................................. 263 Retrieve Installed RPM Package Name by RPM File ...................................................................................... 264 Run Command Line ....................................................................................................................................... 265 Run InstallAnywhere ...................................................................................................................................... 267 Run InstallAnywhere with Predefined Answer File .......................................................................................... 269 Run InstallShield with Answer File .................................................................................................................. 270 Run MSI Installer ........................................................................................................................................... 271 Uninstall RPM Package ................................................................................................................................. 272

Check if RPM Package is Installed This action checks if the specified package is listed in the RPM packages database. The action supports systems that support RPM packages.

Input Values

Mandatory

• Package Name ( String )

Package name to check if Is Installed.

Advanced

• Rpm Executable Path ( String )

Path to the RPM executable. Default value is /bin/rpm.

• Is Installed ( Boolean )

Determines the check mode. If True, then the package is expected to be installed. If False, the package is expected not to be installed. Default value is True.

Output Values None

Chapter 10 Installation Actions


Execute JavaScript Code This action evaluates the JavaScript code and executes it.

Input Values

Mandatory

• Script

JavaScript code.

Advanced

• Input3 ( String )

String input for the script. Its name within script will be 'input3'.

• Array Input2 ( String[] )

Array input variable for the script. Its name within script will be 'arrinput2'.


String input variable for the script. Its name within script will be 'input1'.

• Array Input3 ( String[] )


• Array Input ( String[] )



String input for the script. Its name within script will be 'input2'.

Output Values • Output1 ( String )

String output for variable 'output1'.

• Result Output ( String )

Output of script execution. Valid only if output is not an array.

• Array Result Output ( String[] )

Output of script execution. Valid only if output is an array.

• Array Output1 ( String[] )

Array output for variable 'arrOutput1'.

• Array Output2 ( String [] )

Execute JavaScript Code



• Output2 ( String )


• Array Output3 ( String [] )


• Output3 ( String )


Example Following is an example of the Execute JavaScript Code action:

// String adding output1 = input1 + <integer> ; // integer adding output2 = <integer> + <integer> // array assignment arrOutput1 = arrInput1; var d = new Date(); var time = d.getHours(); // if statement if (time < 10) { output3 = "early"; } else { output3 = <late>; } time;

Action Input Parameter Values

• Input1 value = 1 (Script variable: Input1)

• Array Input 1 value = [a,b,c] (Script variable: ArrInput1)

User Input Parameter Values

• Integer parameter value = 5 (Script input variable: <integer>)

• String parameter value = "late" (Script input variable: <late>)



Install RPM Package This action installs the specified RPM package. If the package installation finishes successfully, the name of the installed package will be set in the RPM Package Name output.

Note: This action supports only systems that support RPM packages.

Input Values

Mandatory

• RPM Package Path ( String )

Path to the RPM package to install.

Advanced



Output Values • RPM Package Name ( String )

Name of RPM package contained in the specified RPM file.

Install Windows Service


Install Windows Service This action installs a Windows service with all required configuration definitions.

Note: This action is supported only on Windows systems.

Note: This action will NOT start the service after installation.

Input Values

Mandatory

• Service Name ( String )

Name of the Windows service to be installed.

• Service Display Name ( String )

Display name of service to be installed.

• Executable Path ( String )

Full path of the executable to be installed as a service.

Advanced

• Startup Type ( ServiceStartupType )

Service startup type.

• Start Account ( String )

Start account for the service. This value should be entered in the format DomainName\UserName.

For local users use: .\LocalUser.

For local system accounts, leave this input value blank.


Password for the start account.

Output Values None



Retrieve Installed RPM Package Name by RPM File This action retrieves the RPM package name from an RPM file.


Input Values

Mandatory

• RPM File Path ( String )

Path to the RPM file.

Advanced




Package name of the installed RPM file.

Run Command Line


Run Command Line This step executes the specified command line as if it was executed from command line shell.

It is possible to execute the command line in the background and not wait for it to finish its execution by setting the Wait For Process To Finish input to False.

Input Values

Mandatory

• Command Line

Command line to run.

• Work Directory

Working directory from which to run.

Advanced

• Environment Variables Names ( String[] )

List of environment variables names to be set as the environment variables for the created process. Order should match Environment Variables Values input.

• Std Out File Path ( String )

File path to use to write the output stream of the process.

• Wait For Process To Finish ( Boolean )

Whether to wait for the process to finish its execution or not: True for wait, False not to wait.

On non-Windows systems, the step will fail if set to False.

• Environment Variables Values ( String [] )

List of environment variables values to be set as the environment variables for the created process. These values should match the names order in the Environment Variables Names input.

• Std Err File Path ( String )

File path to use to write the error stream of the process. If not set, then the standard error is redirected to the standard output.

• Time Out Duration ( Long )

Time to wait for the process in seconds. Relevant only if Wait For Process To Finish is set to True.

• Expected Return Value ( Long )

Expected return value of the finished process. If specified and actual return values are not equal, action will fail.



Output Values • Std Out Output ( String )

Standard output of the process. Valid only if Wait For Process To Finish is set. A maximum of 256 characters will be returned.

• Std Err Output ( String )

Standard error of the process. Valid only if Wait For Process To Finish is set. A maximum of 256 characters will be returned.

• Return Value ( Long )

Return value of the finished process.

Run InstallAnywhere


Run InstallAnywhere This action runs the specified InstallAnywhere installer.

Notes:

The installer to be run must support silent installation.

Properties to the installer can be set using the List Keys and List Values inputs, e.g. a key would be PORT_NUMBER and a matching value would be 8080. The Log File Directory and Log File Name inputs must be set to valid values.

The type of Log file that the installer will generate depends on the version of InstallAnywhere with which the installer was built. For installers built with InstallAnywhere, Studio version 8 and above use an XML Log, and for lower versions use a Text Log. The type of log can be set using the Is XML Log Format input.

If the Is XML Log Format input is set to an incorrect value then the installer will run successfully, but the action might fail.

While running, some InstallAnywhere installers may display a Progress dialog box. This is normal; do not close this dialog box.

Input Values

Mandatory

• Log File Name

Name for the log file.

• Log File Directory

Directory in which the log file is to be generated.

• Installer Path

Path to the InstallAnywhere setup file. An explicit value can be set, or a File parameter can be used.

Advanced

• Is XML Log Format ( Boolean)

Whether to generate an XML Log file or a Text Log file. True for XML, False for text.

• List Values ( String[] )

List of property values. (This input may be empty if no properties are needed.)

• List Keys ( String[] )

List of property keys. (This input may be empty if no properties are needed.)



Output Values • Generated Log File Full Path ( String )

Full path to the generated log file.

Run InstallAnywhere with Predefined Answer File


Run InstallAnywhere with Predefined Answer File This action runs the specified InstallAnywhere installer with the designated predefined answer file.

Notes:

The installer to be run must support silent installation.

By default the installer will look for the answer file in the same directory of the installer. The answer file name must be 'installer.properties'. The properties in the 'installer.properties' file must be in a key=value format, e.g. PORT_NUMBER=8080. The property INSTALLER_UI=silent, must be set in the answer file in order to force the installer to run in silent mode.

The Log File Directory and Log File Name inputs must be set to valid values. The type of Log file that the installer will generate depends on the version of InstallAnywhere with which the installer was built. For installers built with InstallAnywhere Studio version 8 and above use an XML Log, and for lower versions use a Text Log. The type of log can be set using the Is XML Log Format input.

If the Is XML Log Format input is set to the incorrect value then the installer will run successfully but the action might fail.

While running, some InstallAnywhere installers may display a Progress dialog box. This is normal; do not close this dialog box.

Input Values • Installer Path

Path to the InstallAnywhere setup file. An explicit value can be set, or a File parameter can be used.

• Log File Directory

Directory in which the log file is to be generated.

• Log File Name

Name for the log file.

Advanced

• Is XML Log Format ( Boolean )

Whether to generate an XML Log file or a Text Log file. True for XML, False for text.

Output Values • Generated Log File Full Path ( String )

Full path to the generated log file.



Run InstallShield with Answer File This action runs the specified InstallShield installer with the specified answer file.

For details on how to create the required answer file, see the InstallShield documentation.

Input Values

Mandatory

• Installer Path ( String )

Path to the InstallShield setup file.

• Answer File Path ( String )

Path to the answer file.

Output Values • Generated Log File Path ( String )

Path to the log file to be created by installer.

Run MSI Installer


Run MSI Installer This action runs the specified MSI installer with the specified property keys and values.

The MSI installer can be run in two execution modes: Install or Uninstall.

Input Values

Mandatory


Path to the MSI Installer file.

Advanced

• MSI Execution Mode ( RunMSInstall$Mode )

MSI Installer execution mode: Install or Uninstall.


List of property keys. If no properties are needed, this input value may be left empty.


List of property values. If no properties are needed, this input value may be left empty.

• Log File Details Level ( String )

Log details level. Possible options are /L[i][w][e][a][r][u][c][m][p][v][+][!][*]. Leave this input blank if the log file is not needed.

• Log File Path ( String )

Path to the log file to be created by MSI Installer. The log file will be created only if the Log File Details Level input is set.

Output Values None



Uninstall RPM Package This action uninstalls the specified RPM package.

Note: This action is supported only on systems that support RPM packages.

Input Values

Mandatory

• RPM Package Name ( String )

Name of the RPM Package to be uninstalled.

Advanced



Output Values None


Chapter 11

JMX Action

In This Chapter

Activate JMX .................................................................................................................................................. 273

Activate JMX This action invokes an operation on an existing MBean with or without objects.

If the remote connector uses SSL, set the Is SSL input to True and fill in a valid trust store path (path to the file holding the list of trusted hosts store) in the Trust Store Path input, and fill in a valid key store path (path to the file of keys store) in the Keys Store Path input.

If the remote connec tor us es SSL:

1 Set Is SSL input to True.

2 Enter a valid trust store path (the path to the file holding the trusted hosts store) in the Trust Store Path input.

3 Enter in a valid key store path (path to the file of key store) in the Key Store Path input.

Input Values

Mandatory

• Server URL ( String )

JMX server host name. Add the character '/' in front of JNDI references, for example: /jndi/rmi://DOMAIN

• JMX Name ( String )

Name of the JMX MBean to activate. A lookup for the MBean name is performed before the MBean is activated.

• Operation Name ( String )

Name of the method (Operation) in the specified MBean that is activated.

Advanced


User name to use to log in to the JMX Server. Leave blank if no login is needed.

Chapter 11 JMX Action



User password to use to log in to the JMX Server. Leave blank if no login is needed.


JMX server port number to use to connect to the JMX server.

• Base Dir Path ( String )

JMX base directory path to use in the JMX server connection string, for example, the value is used like this as the connection string: service:jmx:rmi://myjmxhost:8080/jmxrmi

• Operation Parameters ( Serializable[] )

Array of values to pass to the method specified in the Operation Name input. The way to pass object array, is by using an Object Array Parameter.

• Operation Parameter Types ( String[] )

Array of the types of values specified in the Operation Parameters input, the types should be ordered the same as the Operation Parameters specified.

• Is SSL ( Boolean )

Set to True if the connection to the JMX server should be created using SSL.

• Trust Store Path ( String )

Path to the trust store to use with the connection to the JMX server. This value is needed only if using SSL to create the connection to the JMX server, as indicated by the Is SSL input.


Path to the trust store to use with the connection to the JMX server. This value is needed only if using SSL to create the connection to the JMX server, as indicated by the Is SSL input.

• Keystore Path ( String )

Path to the key store to use with the connection to the JMX server. This value is needed only if using SSL to create the connection to the JMX server, as indicated by the Is SSL input.

• Keystore Password ( Password )

Key store password to use with the connection to the JMX server. This value is needed only if using SSL to create the connection to the JMX server, as indicated by the Is SSL input.

Output Values • Return Object ( Object )

Return value of the method (Operation) specified after invocation, if this action has failed this output will return null, this output should be used with an Object Parameter.


Chapter 12

Math Actions

In This Chapter

Calculate Two Numbers ................................................................................................................................. 275 Create Random Number ................................................................................................................................ 276

Calculate Two Numbers This action takes two numbers and calculates the specified operation.

Input Values

Mandatory

• First Number

First number.

• Operation

Arithmetic operation to perform.

• Second Number

Second number.

Output Values • Result as Long ( Long )

Result as Integer.

• Result as Double ( Double )

Result as Double.

• Result as Float ( Float )

Result as Float.

• Result as Integer ( Integer )

Result as Integer.

Chapter 12 Math Actions


Create Random Number This action creates a random number according to specified inputs.

Input Values

Advanced

• Int Between Zero To This ( int )

Enter a number so that the returning random number is between zero and this number (applies to Int type only). Leave empty to return any random number ( int ).

Output Values • Random Gaussian ( Double )

Random Gaussian ( Double ).

• Random Int ( int )

Random integer.

• Random Boolean ( Boolean )

Random Boolean.

• Random Float ( float )

Random float.

• Random Long ( long )

Random long.

• Random Double ( Double )

Random double.


Chapter 13

Network Actions

In This Chapter

Check Free Ports ........................................................................................................................................... 277 Disconnect Network Drive .............................................................................................................................. 279 Get IPs of localhost ........................................................................................................................................ 280 Map Network Drive ........................................................................................................................................ 281 Ping a Device ................................................................................................................................................ 282 Telnet Session ............................................................................................................................................... 283

Check Free Ports This action checks whether specified ports are free.

If any specified port is not free, the action result is False. The Array Of Ports list can be specified by an array of integers or by a comma-separated list.

The contents of both inputs (Comma Separated Ports input and Array Of Ports input) are checked, and at least one of the inputs must be filled.

Input Values

Advanced

• Array Of Ports ( Integer[] )

Array of ports, can be used with an Integer Array Parameter. This input can be empty if the Comma Separated Ports is used.

• Comma Separated Ports ( String )

Comma-separated list of ports to check, for example: 8080,8081,8082. This input can be empty string if the Array of Ports is used.

• Check As UDP Ports ( Boolean )

Whether the checked ports are UDP (True) or TCP (False).

• Expect Ports To Be Free ( Boolean )

Whether the action should expect the ports to be free or taken, True for free, False for taken.

Chapter 13 Network Actions


Output Values None

Disconnect Network Drive


Disconnect Network Drive This action disconnects a network mapped drive. This action supports MS Windows platform only.

Input Values

Mandatory Inputs

• Local Drive Letter ( String )

Local drive letter to be disconnected.


Disconnect if there are open files or jobs on the connection.

Output Values None



Get IPs of localhost This action retrieves the IP assigned to the current machine.

Input Values

Advanced

• Starts With ( String )

Chooses the IP address that starts with this string (e.g. 192.168.0).

Leave empty for any value.

Output Values • IP ( String )

Contains the first IP address returned of the current machine or the one matching the specified look up string.

• IPs ( String[] )

Contains the list of IPs found for the current machine.

Map Network Drive


Map Network Drive This action maps a local drive to a network path. This action is supported on MS Windows platform only.

Input Values

Mandatory Inputs

• Network Path ( String )

Full network path to be mapped.

• Local Drive Letter ( String )

Local drive letter to be mapped.

Output Values None



Ping a Device This actions pings a given device (Host, Network Switch, Storage Unit, etc.).

Input Values

Mandatory

• Device name

Target server name or IP.

Advanced

• Time out ( Integer )

Maximum time (in seconds) to wait for a response.

Output Values • Reply time ( Long )

Round-trip time (in milliseconds). Will be null in case the ping will fail.

Telnet Session


Telnet Session This action provides the ability to create a Telnet session, including authentication and the sending of Telnet commands to the remote Telnet server.

Input Values

Mandatory

• Telnet Host ( String )

Host name of the Telnet server.

• Telnet Commands ( String[ ] )

Telnet commands to be executed once connected.

Advanced

• Telnet Port ( Integer )

Telnet port to be used.

• Prompt ( String )

Prompt to be displayed during the course of the ongoing Telnet session.

• Telnet output ( String )

Output of Telnet's commands.

• Login Prompt ( String )

Prompt to be displayed for logging in, once connected.

• Password Prompt ( String )

Prompt to be displayed for entering the user password, once connected.


User name to be entered when logging on to the Telnet host.

• Login Successful Prompt ( String )

Prompt to be displayed when the login is successful.


User password to be entered when logging on to the Telnet host.

Output Values • Telnet output ( String )



Chapter 14

OS Actions

In This Chapter

Linux/Unix Actions ......................................................................................................................................... 285 Windows Actions ........................................................................................................................................... 291 Check OS Type ............................................................................................................................................. 344 Get Environment Variable Value .................................................................................................................... 345 Get Java System Property ............................................................................................................................. 346

Linux/Unix Actions

Check if RPM Package is Installed This action checks if the specified package is listed in the RPM packages database. The action supports systems that support RPM packages.

Input Values

Mandatory

• Package Name ( String )

Package name to check if Is Installed.

Advanced



• Is Installed ( Boolean )

Determines the check mode. If True, then the package is expected to be installed. If False, the package is expected not to be installed. Default value is True.

Output Values None

Chapter 14 OS Actions


Check if User has Root Credentials This action checks if the user credentials specified are of a user that belongs to the root group. This action supports Unix/Linux systems only.

Input Values

Mandatory


User password on which to verify root rights.


User name on which to verify root rights.

Output Values None

Linux/Unix Actions


Get Unix/Linux OS Details This action retrieves various parameters of underlying Unix/Linux and similar OS. This action relies on "uname" system utility.

Output Values • Os Platform ( String )

Underlying OS platform as reported by uname -m.

• Os Version ( String )

Underlying OS release (version) as reported by uname -r.

• OS Name ( String )

Underlying OS name as reported by uname -s.

• Is 32bit ( Boolean )

Returns True if underlying platform is 32bit, False if it is 64bit.



Install RPM Package This action installs the specified RPM package. If the package installation finishes successfully, the name of the installed package will be set in the RPM Package Name output.


Input Values

Mandatory

• RPM Package Path ( String )

Path to the RPM package to install.

Advanced




Name of RPM package contained in the specified RPM file.

Linux/Unix Actions


Retrieve Installed RPM Package Name by RPM File This action retrieves the RPM package name from an RPM file.


Input Values

Mandatory

• RPM File Path ( String )

Path to the RPM file.

Advanced




Package name of the installed RPM file.



Uninstall RPM Package This action uninstalls the specified RPM package.

Note: This action is supported only on systems that support RPM packages.

Input Values

Mandatory

• RPM Package Name ( String )

Name of the RPM Package to be uninstalled.

Advanced



Output Values None

Windows Actions


Windows Actions

Change Credentials for Windows Service This action changes the start account and password of windows service. This action is supported on Windows systems only.

Input Values

Mandatory


Service name or display name of the service to start, the name specified is case-insensitive, but must be the exact service name or exact display name.


Start account for the service. Should be provided in the form of DomainName\UserName. For local users use: .\LocalUser and for local system account use: LocalSystem.

Advanced





Output Values None



Check if Service Exists This action checks whether a certain service exists.

Input Values

Mandatory


Name of service to query.

Advanced

• Fail if Not Exist ( Boolean )

Set to True for action to fail if the service does not exist, otherwise set to False.

Output Values None

Windows Actions


Check Service Status This action checks the status of a certain service.

Input Values

Mandatory

• Expected Status ( CheckServiceStatus$ServiceStatus )

Expected status of the service.


Name of service to query.

Output Values None



Create a Windows Registry Key This action creates a Windows Registry Key. This action supports Windows systems only.

Input Values

Mandatory

• New Key Name ( String )

New registry key name to create.

• Parent Folder Path

Path to the folder in which the target registry key is created.

• New Key Value ( String )

Value to assign to the new registry key.

Advanced

• If Exists Action Mode ( CreateRegistryKey$Amode )

What action to take if the key already exists.

• Should Create Parent Folder Path ( Boolean )

Whether to create the full path specified if it does not exist.

• New Key Type ( String )

Specifies the type of registry key to create; this can be either: 'SZ', 'BINARY', or 'DWORD'.

• Root Hive Name ( CreateRegistryKey$RootRegistryHive )

Registry root hive name.

Output Values None

Windows Actions


Delete a Windows Service This action deletes a specified Windows service.

This action is supported on Windows systems only.

If the service is not stopped or another process has an active reference to it, the service will be marked for deletion and deleted only when stopped and no other process has an active reference to it.

Input Values

Mandatory

• Service Name

Name of the service to delete.

Advanced

• Fail If Not Immediately Deleted ( Boolean )

Whether the action should fail if the service is not deleted immediately.

Output Values

None



Delete Windows Registry Folder This action deletes a folder in the Windows registry. The action supports Windows systems only.

Input Values

Mandatory


Path to the folder to delete.

Advanced



Output Values

None

Windows Actions


Delete Windows Registry Key This action deletes a Windows Registry folder. This action supports Windows systems only.

Input Values

Mandatory


Path to the folder that contains the key to delete.


Registry key name to delete.

Advanced




Whether to fail if the key does not exist. True to fail, False to ignore.

• Key Type ( String )

Type of registry key to delete. The valid types are SZ, BINARY, and DWORD.

Output Values None



Get Microsoft Windows OS Details This action retrieves various parameters of underlying Microsoft Windows OS.

Input Values None

Output Values • Is Windows 2000 ( Boolean )

Returns True if underlying OS is Microsoft Windows 2000.

• Is Windows XP ( Boolean )

Returns True if underlying OS is Microsoft Windows XP.

• Is Windows 2003 ( Boolean )



Returns True if underlying OS is Microsoft Windows Vista.



• Service Pack ( String )

Returns the service pack information.

• Service Pack Number ( int )

Returns number of service pack if present, -1 if not present.

• Is Windows Vista ( Boolean )

Returns True if underlying OS is Microsoft Windows Vista.

• Is 32bit ( Boolean )

Returns True if underlying platform is 32bit, False if it's 64bit.

Windows Actions


Get Windows Registry Key Value This action locates and retrieves the value of the specified registry key.


Input Values

Mandatory


Registry key whose value is to be retrieved.

• Parent Folder Path ( String )

Path to the folder containing the target registry key.

• Root Hive Name ( RootRegistryHive )

Name of the registry root hive where the key whose value is to be retrieved resides.

Advanced

• Expected Value ( String )

Value to expect in the key. This input can be used to expect either that a certain value should exist or that a certain value should not exist.

• Is Value Expected ( Boolean )

Whether the registry key should exist and its value should match the expected value, or whether the key should not exist or its value should not match the expected value.

Select True if the key should exist.

Select False if the key should not exist.


Type of registry key to retrieve. Valid values are:

SZ

BINARY

DWORD

Output Values • Retrieved Value ( String )

Value of the registry key.



Get Windows Service Properties This action retrieves an existing windows service's properties: display name, description, and so on.

Input Values

Mandatory

• Service Name

Service name to modify.

Output Values

• Binary Path ( String )

Service binary path. Leave blank for an unchanged value.


Service display name, leave blank for unchanged value.


Service logon user name, for domain users use the DOMAIN\USERNAME syntax otherwise use the .\USERNAME syntax, leave blank for unchanged value.

• Service Description ( String )

Service description, leave blank for unchanged value.

• Interactive ( Boolean )

Whether to set the interactive flag, this field is relevant only if the LocalSystem account is used, leave blank for unchanged value.

• Service Startup Type ( ServiceStartupType )

Service startup mode, leave blank for unchanged value.

Windows Actions


INI File Actions

Get Value from an INI file

This action finds a key in a section of an INI file and returns its value. If the INI file, section or key is missing then the action will fail. If the needed key is not in any section the INI Section Name input can be left blank.

Input Values

Mandatory

• INI Key Name

The name of the key to find.

• INI File Path

The path to the INI file.

Advanced


The name of section that contains the key.

Output Values • INI Key Value ( String )

The current index of the iterations.



Manipulate INI File

This action adds or updates an INI file. It is possible to specify a section to which the added or updated keys should belong. If no section is needed, leave the INI Section Name input blank, In addition, set the Section Should Exist input to False.

Input Values

Mandatory

• INI File Path ( String )

Path to the INI file.

• Key Value Array ( String[] )

Array of strings, each having the format "key=value".

Advanced


Name of the INI section that contains the keys.

• Section Should Exist ( Boolean )

Whether to create the specified section if it does not exist. True for ignore, False for create.

• Key Value Separator ( String )

Character used as a separator in each string in the Key Value Array input.

Output Values None

Windows Actions


Install Windows Service This action installs a Windows service with all required configuration definitions.


Note: This action will NOT start the service after installation.

Input Values

Mandatory


Name of the Windows service to be installed.


Display name of service to be installed.


Full path of the executable to be installed as a service.

Advanced




Start account for the service. This value should be entered in the format DomainName\UserName.

For local users use: .\LocalUser.

For local system accounts, leave this input value blank.



Output Values None



Modify MSDTC Settings This action modifies MSDTC settings.

Input Values

Advanced

• Network Dtc Access Inbound ( Boolean )

Whether network DTC inbound access is enabled.

• Network Dtc Access ( Boolean )

Whether network DTC access is enabled.

• Network Dtc Access Outbound ( Boolean )

Whether network DTC outbound access is enabled.

• Network Dtc Access Client ( Boolean )

Whether network DTC client access is enabled.

• Network Dtc Access Tip ( Boolean )

Whether network DTC tip access is enabled.

• Turn Off Rpc Security ( Boolean )

Whether DTC turn off of RPC security is enabled.

• Security Account Name ( String )

DTC Service Account Name.

• Fallback To Unsecure RPC If Necessary ( Boolean )

Whether DTC fallback to unsecure RPC if necessary is enabled.

• Network Dtc Access Transactions ( Boolean )

Whether network DTC transactions access is enabled.

• XA Transactions ( Boolean )

Whether DTC XA transactions is enabled.

• Allow Only Secure Rpc Calls ( Boolean )

Whether DTC allows only secure RPC calls is enabled.

• Network Dtc Access Admin ( Boolean )

Whether network DTC administrative access is enabled.

• Domain Controller State ( Boolean )

Windows Actions


Whether domain controller state is enabled.

Output Values None



Modify Windows Service Properties This action modifies the current properties of an existing Windows service: display name, description, etc.

Important: To retain the current value of any property, that is, to NOT modify it, leave blank the corresponding Advanced input value.

Input Values

Mandatory


Name of the Windows service whose properties are to be selectively modified.

Advanced

• Service Startup Type ( ServiceStartupType )

Service startup mode. Leave blank for an unchanged value.

• Subsequent Failure Action ( ServiceFailureAction )

Action to be performed with each subsequent service failure after the Second Failure Action. Leave blank for an unchanged value.

• Restart Computer Message ( String )

Message to send to the network before performing the Restart_Computer action. Leave blank for an unchanged value.

• Interactive ( Boolean )

Whether to set the interactive flag. This field is relevant only if the Local System Account is used. Leave blank for an unchanged value.

• Reset Period Days ( Integer )

Time, in days, to wait before resetting the failure counter. Leave blank for an unchanged value.


Service logon user password. Leave blank for an unchanged value.

• Command To Run ( String )

Command to run when performing the Run_Command action. Leave blank for an unchanged value.

• Local System Account ( Boolean )

Whether to use the Local System account as the logon account. Leave blank for an unchanged value.

• Second Failure Action ( ServiceFailureAction )

Windows Actions


Second action to be performed when the service fails. Leave blank for an unchanged value.

• Restart Computer Delay Minutes ( Integer )

Time, in minutes, to wait before performing the Restart_Computer action. Leave blank for an unchanged value.


Service logon user name.

For domain users, use the DOMAIN\USERNAME syntax.

Otherwise, use the .\USERNAME syntax.

Leave blank for an unchanged value.

• First Failure Action ( ServiceFailureAction )

First action to be performed when the service fails. Leave blank for an unchanged value.


Service display name. Leave blank for an unchanged value.

• Service Description ( String )

Service description. Leave blank for an unchanged value.

• Binary Path ( String )

Service binary path. Leave blank for an unchanged value.

• Restart Service Delay Minutes ( Integer )

Time, in minutes, to wait before performing the Restart_Service action. Leave blank for an unchanged value.

Output Values None



MSMQ Actions

Attach MSMQ Rules to Trigger

This action attaches MSMQ rules to a trigger.

Input Values

Mandatory

• Rules Names Or IDs

Array of rule names or IDs.

• Trigger Name Or ID

Trigger name or ID.

Advanced

• Lookup Trigger By Id ( Boolean )

Whether to find the trigger by its ID or its name.

• Fail If Trigger Not Exist ( Boolean )

Whether to fail if the trigger does not exist.

• Lookup Rules By Id ( Boolean )

Whether to find the rules by their IDs or by their names.

• Fail If Rules Not Exist ( Boolean )

Whether to fail if one of the rules does not exist.

• Replace Old Rules ( Boolean )

Whether to replace the old rules attached to this trigger.

Output Values None

Windows Actions


Check if MSMQ Queue Exists

This action checks if an MSMQ queue exists.

Input Values

Mandatory

• Queue Path Name ( String )

Queue path name.

Advanced


Whether to expect the queue to exist.

Output Values None



Check if MSMQ Rule Exists

This action checks if the MSMQ rule exists.

Input Values

Mandatory

• Rule name or ID

Rule name or ID to find.

Advanced


Whether to expect the rule to exist.

• Lookup By Id ( Boolean )

Whether to find the rule by its ID or by its name.

Output Values • Rule Name ( String )

Rule name.

• Rule Id ( String )

Rule ID.

Windows Actions


Check if MSMQ Trigger Exists

This action checks if the MSMQ queue trigger exists.

Input Values

Mandatory

• Trigger Name Or ID ( String )

Trigger name or ID.

Advanced


Whether to expect the Trigger to exist.


Whether to find the trigger by its ID or name.

Return Values • Trigger ID ( String )

Trigger ID.



Compare Two File Checksums

This action checks the checksum of two files and compares them.

Input Values

Mandatory


First file path.


Second file path.

Advanced









Windows Actions


Create MSMQ Queue

This action creates an MSMQ queue.

Input Values

Mandatory

• Queue Label ( String )

Queue label.


Queue path name (for private queue use PRIVATE$) for example: .\PRIVATE$\NewQueue

Advanced

• Base Priority ( int )

Queue base priority (relevant to public queues only).

• Service Type Guid ( String )

Queue GUID.

• Multicast Address ( String )

Multicast address.

• Should Set Queue Quota ( Boolean )

Whether to set the queue quota.

• Should Set Multicast Address ( Boolean )

Whether to set the multicast address.

• Should Set Journal Quota ( Boolean )

Whether to set journal quota.

• Journal Mode ( MessageQueueJournalMode )

Queue journal mode.

• Is World Readable ( Boolean )

Should create a queue world readable.

• Should Authenticate Message ( MessageQueueAuthenticationMode )

Whether messages should be authenticated.

• Queue Quota In Kilo Bytes ( int )

Queue quota in KB.



• Is Transactional Queue ( Boolean )

Should create transactional queue.

• Journal Quota ( int )

Journal quota, in KB.

• Queue Privacy Level ( MessageQueuePrivacyLevel )

Queue privacy level.

• Should Fail If Exist ( Boolean )

Whether to fail if the queue already exists.

Output Values None

Windows Actions


Create MSMQ Rule

This action creates the MSMQ rule.

Input Values

Mandatory

• Rule Description ( String )

Rule description.

• Rule Action Executable Command ( String )

Rule executable action command (relevant for the EXE action type).

• Rule Action Com Method ( String )

Rule COM action command method name (relevant for the COM action type).

• Rule Name ( String )

Rule name.

• Rule Conditions ( String[] )

Rule conditions can be an array of the following keys

(e.g. $MSG_LABEL_CONTAINS=MyLabel),

Rules Conditions

Message Label Contains $MSG_LABEL_CONTAINS

Message Label Does Not Contain

$MSG_LABEL_DOES_NOT_CONTAIN

Message Body Contains $MSG_BODY_CONTAINS

Message Body Does Not Contain

$MSG_BODY_DOES_NOT_CONTAIN

Message Priority Equals $MSG_PRIORITY_EQUALS

Message Priority Not Equal $MSG_PRIORITY_NOT_EQUAL

Message Priority Greater Than $MSG_PRIORITY_GREATER_THAN

Message Priority Less Than $MSG_PRIORITY_LESS_THAN

Message AppSpecific Equals $MSG_APPSPECIFIC_EQUALS

Message AppSpecific Not Equal $MSG_APPSPECIFIC_NOT_EQUAL



Message AppSpecific Greater Than

$MSG_APPSPECIFIC_GREATER_THAN

Message AppSpecific Less Than $MSG_APPSPECIFIC_LESS_THAN

Message Source Machine ID Equals

$MSG_SRCMACHINEID_EQUALS

Message Source Machine ID Not Equal

$MSG_SRCMACHINEID_NOT_EQUAL

• Rule Action Com Program ID ( String )

Rule COM action program ID (relevant for the COM action type).

• Rule Action Parameters ( String[] )

Rule action parameters can be an array of the following items

(e.g. $MSG_ID)

Rules Parameters

Message ID $MSG_ID Variant

Message Label $MSG_LABEL String

Message Body as Variant $MSG_BODY Variant

Message Body as String $MSG_BODY_AS_STRING String

Message Priority $MSG_PRIORITY Number

Message Correlation ID $MSG_CORRELATION_ID Variant

Queue Path Name $MSG_QUEUE_PATHNAME String

Queue Format Name $MSG_QUEUE_FORMATNAME String

Response Queue Format Name

$MSG_RESPONSE_QUEUE_FORMATNAME String

Admin Queue Format Name $MSG_ADMIN_QUEUE_FORMATNAME String

Message App Specific Number $MSG_APPSPECIFIC Integer

Message Sent Time $MSG_SENTTIME Variant (date)

Message Arrived Time $MSG_ARRIVEDTIME Variant (date)

Message Source Machine $MSG_SRCMACHINEID String

Windows Actions


Trigger Name $TRIGGER_NAME String

Trigger ID $TRIGGER_ID String

Advanced

• Rule Implementation Class ( String )

Rule implementation class.

• Fail If Name Exist ( Boolean )

Whether to fail if the rule already exists.

• Create Anyway If Name Exist ( Boolean )

Whether to create the rule anyway if the rule name already exists.

• Rule Action Type ( String )

Rule action type (can be either EXE or COM).

• Executable Command Interaction With Desktop ( Boolean )

Whether to allow the executable action command to interact with the desktop (relevant for the EXE action type).

Output Values • Rule ID ( String )

Rule ID.



Create MSMQ Trigger

This action creates an MSMQ Queue trigger.

Input Values

Mandatory

• Queue Path ( String )

Queue path.

• Trigger Name ( String )

Trigger name.

Advanced

• Message Processing Type ( TriggerMessageProcessingType )

Trigger message processing type.

• Enabled ( Boolean )

Whether the trigger is enabled.

• System Queue Mode ( SystemQueueMode )

System queue mode.


Whether to fail if the trigger already exists.

• Serialized ( Boolean )

Whether the trigger is serialized.

Output Values • Trigger Id ( String )

Trigger ID.

Windows Actions


Delete MSMQ Queue

This action deletes the MSMQ queue.

Input Values

Mandatory


Queue path name.

Advanced


Whether to expect the Queue to exist.

Output Values None



Delete MSMQ Rule

This action deletes an MSMQ rule.

Input Values

Mandatory

• Rule Name Or ID ( String )

The rule name or ID to find.

Advanced

• Lookup By ID ( Boolean )



Whether to expect the rule to exist.

Output Values None

Windows Actions


Delete MSMQ Trigger

This action deletes the specified MSMQ trigger.

Input Values

Mandatory

• Trigger Name Or Id ( String )

Trigger name or ID.

Advanced


Whether to fail if the trigger exists or not.

• Lookup By ID ( Boolean )

Whether to find the trigger by its ID or its name.

Output Values • Trigger ID ( String )

Trigger ID.



Detach MSMQ Rules from Trigger

This action detaches the MSMQ rules from trigger.

Input Values

Mandatory

• Rules Names Or IDs

An array of rules names or IDs.

• Trigger Name Or ID ( String )

Trigger name or ID.

Advanced

• Lookup Rules By Id ( Boolean )

Whether to find the rules by their IDs or by their names.

• Fail If Rules Not Exist ( Boolean )

Whether to fail if one of the rules does not exist.

• Fail If Trigger Not Exist ( Boolean )

Whether to fail if the trigger does not exist.

• Lookup Trigger By Id ( Boolean )

Whether to find the trigger by its ID or by its name.

• Detach All ( Boolean )

Whether to ignore the rule names or ID arrays and detach all the rules from this trigger.

Output Values None

Windows Actions


Get MSMQ Queue Info

This action retrieves MSMQ Queue information.

Input Values

Mandatory


Queue path name.

Advanced

• Should Fail If Not Exist ( Boolean )

Whether to fail if the queue does not exist.

Output Values • Service Type Guid ( String )

Queue service type GUID.

• Journal Quota ( int )

Queue journal quota, in KB.

• Journal Mode ( Boolean )

Queue journal mode.

• Creation Time As Long ( Long )

Queue creation time, as long.

• Queue Label ( String )

Queue label.

• Queue Quota In Kilo Bytes ( int )

Queue quota, in KB.


Whether this message queue is transactional.


Whether this message queue is world readable.

• Queue Privacy Level ( String )

Queue privacy level.

• Multicast Address ( String )



Queue multicast address.

• Base Priority ( int )

Queue's base priority. This value is relevant to public queues only.

• Should Authenticate Message ( Boolean )

Whether messages are authenticated.

• Modify Time As Long ( Long )

Queue modified time, as a long.

Windows Actions


Get MSMQ Rule Information

This action retrieves MSMQ rule information.

Input Values

Mandatory

• Executable Command Interact With Desktop

Whether to let the executable action command interact with the desktop (relevant for the EXE action type).

• Rule Name Or Id ( String )

Rule name or ID to find.

Advanced


Whether to fail if the rule already exists.



Output Values • Rule Implementation Class ( String )


• Rule Action And Parameters ( String )

Rule action type (either EXE or COM).

• Rule Id ( String )

Rule ID.


Rule description.

• Rule Conditions ( String )

Rule conditions.

• Rule Name ( String )

Rule name.



Get MSMQ Trigger Information

This action retrieves MSMQ trigger information.

Input Values

Mandatory


Trigger name or ID from which to retrieve information.

Advanced

• Fail If Not Exist

Whether to fail if the trigger is not found.




Trigger ID.

• Trigger Name ( String )

Trigger name.


Trigger message processing type.


System queue mode.


Whether the trigger is serialized.

• Rules Count ( int )

Attached rules count.




Queue path.

Windows Actions


Modify MSDTC Settings

This action modifies MSDTC settings.

Input Values

Advanced

• Network Dtc Access Inbound ( Boolean )

Whether network DTC inbound access is enabled.

• Network Dtc Access ( Boolean )

Whether network DTC access is enabled.

• Network Dtc Access Outbound ( Boolean )

Whether network DTC outbound access is enabled.

• Network Dtc Access Client ( Boolean )

Whether network DTC client access is enabled.

• Network Dtc Access Tip ( Boolean )

Whether network DTC tip access is enabled.

• Turn Off Rpc Security ( Boolean )

Whether DTC turn off of RPC security is enabled.

• Security Account Name ( String )

DTC Service Account Name.

• Fallback To Unsecure RPC If Necessary ( Boolean )

Whether DTC fallback to unsecure RPC if necessary is enabled.

• Network Dtc Access Transactions ( Boolean )

Whether network DTC transactions access is enabled.

• XA Transactions ( Boolean )

Whether DTC XA transactions is enabled.

• Allow Only Secure Rpc Calls ( Boolean )

Whether DTC allows only secure RPC calls is enabled.

• Network Dtc Access Admin ( Boolean )

Whether network DTC administrative access is enabled.

• Domain Controller State ( Boolean )



Whether domain controller state is enabled.

Output Values None

Windows Actions


Modify MSMQ Queue

This action modifies an MSMQ queue.

Input Values

Mandatory


Queue path name. The default is .\\PRIVATE$\\NewQueue.

Advanced

• Should Set Queue Quota ( Boolean )

Whether to set a queue quota.

• New Queue Quota In Kilo Bytes ( int )

Queue quota in KB.

• Should Authenticate Message ( MessageQueueAuthenticationMode )

Whether messages should be authenticated.

• New Journal Mode ( MessageQueueJournalMode )

New queue journal mode.

• New Base Priority ( int )

New queue base priority. This value is relevant to public queues only.

• New Queue Privacy Level ( MessageQueuePrivacyLevel )

New queue privacy level.


Whether to create a transactional queue.

• Create If Not Exist ( Boolean )

Whether to create the queue if it does not exist.

• Should Set Journal Quota ( Boolean )

Whether to set a journal quota.

• New Queue Label ( String )

New queue label.

• New Multicast Address ( String )

New multicast address.




Whether to create a world readable queue.

• Should Set Multicast Address ( Boolean )

Whether to set Multicast address.

• New Service Type Guid ( String )

New queue GUID.

• New Journal Quota ( int )

Queue journal quota in KB.

Output Values None

Windows Actions


Modify MSMQ Rule

This action modifies an MSMQ rule.

Input Values

Mandatory

• Rule Conditions ( String[] )

The rule conditions. Rule conditions can be an array of the following keys:

Message Label Contains - $MSG_LABEL_CONTAINS

Message Label Does Not Contain - $MSG_LABEL_DOES_NOT_CONTAIN

Message Body Contains - $MSG_BODY_CONTAINS

Message Body Does Not Contain - $MSG_BODY_DOES_NOT_CONTAIN

Message Priority Equals - $MSG_PRIORITY_EQUALS

Message Priority Not Equal - $MSG_PRIORITY_NOT_EQUAL

Message Priority Greater Than - $MSG_PRIORITY_GREATER_THAN

Message Priority Less Than - $MSG_PRIORITY_LESS_THAN

Message AppSpecific Equals - $MSG_APPSPECIFIC_EQUALS

Message AppSpecific Not Equal - $MSG_APPSPECIFIC_NOT_EQUAL

Message AppSpecific Greater Than - $MSG_APPSPECIFIC_GREATER_THAN

Message AppSpecific Less Than - $MSG_APPSPECIFIC_LESS_THAN

Message Source Machine ID Equals - $MSG_SRCMACHINEID_EQUALS

Message Source Machine ID Not Equal - $MSG_SRCMACHINEID_NOT_EQUAL

For example, $MSG_LABEL_CONTAINS = MyLabel.

• Rule Name Or Id ( String )

Name or ID of the rule to find.

Advanced

• Create If Name Not Exist ( Boolean )

Whether to create the rule anyway if the rule name already exists.

• Rule Implementation Class ( String )




• Rule Action Parameters ( String[] )

Rule action parameters. Rule action parameters can be an array of the following items:

Message ID - $MSG_ID Variant

Message Label - $MSG_LABEL String

Message Body as Variant - $MSG_BODY Variant

Message Body as String - $MSG_BODY_AS_STRING String

Message Priority - $MSG_PRIORITY Number

Message Correlation ID - $MSG_CORRELATION_ID Variant

Queue Path Name - $MSG_QUEUE_PATHNAME String

Queue Format Name - $MSG_QUEUE_FORMATNAME String

Response Queue Format Name - $MSG_RESPONSE_QUEUE_FORMATNAME String

Admin Queue Format Name - $MSG_ADMIN_QUEUE_FORMATNAME String

Message App Specific Number - $MSG_APPSPECIFIC Integer

Message Sent Time - $MSG_SENTTIME Variant (date)

Message Arrived Time - $MSG_ARRIVEDTIME Variant (date)

Message Source Machine - $MSG_SRCMACHINEID String

Trigger Name - $TRIGGER_NAME String

Trigger ID - $TRIGGER_ID String

For example, $MSG_ID.


Whether the action should fail if the rule does not exist.

• Rule Action Com Program Id ( String )

Rule COM action program ID. This value is relevant for the COM action type.

• Rule Executable Action Command ( String )

Rule executable action command. This value is relevant for the EXE action type.

• Executable Command Interaction With Desktop ( Boolean )

Whether to let an executable action command to interact with the desktop. This value is relevant for the EXE action type.


Windows Actions




Rule description.

• Rule Action Type ( String )

Rule action type. Can be either EXE or COM.

• Rule Action Com Method ( String )

Rule COM action command method name. This value is relevant for the COM action type.

• Update All ( Boolean )

Whether to update all rules with the specified name or the first found.

• New Rule Name ( String )

New rule name.

Output Values • Rule Id ( String )

Rule ID.



Modify MSMQ Trigger

This action modifies the MSMQ queue trigger.

Input Values

Mandatory


Trigger name or ID.

Advanced

• New Trigger Name ( String )

New trigger name.


Queue path.




Whether or the trigger is serialized.


Whether the action should fail if the trigger is not found.


System queue mode.


Trigger Message Processing Type.




Trigger ID.

Windows Actions


Run MSI Installer

This action runs the specified MSI installer with the specified property keys and values.


Input Values

Mandatory



Advanced











Output Values None



Restart Windows Service This action restarts a Windows service by either its service name or its display name.


Input Values

Mandatory


Service name or display name of the service to be restarted.

Although case insensitive, the specified name must be the exact service or display name.

Output Values None

Windows Actions


Run MSI Installer This action runs the specified MSI installer with the specified property keys and values.


Input Values

Mandatory



Advanced











Output Values None



Run Windows Process This action executes the specified Windows executable.


On Windows only, it is possible to start the process in the background and not wait for it to finish its execution, by setting the Wait For Process To Finish input to False.

Input Values

Mandatory • Executable Path ( String )

Path to the executable to be run.

• Work Directory ( String )

Working directory of the executable to be run.

Advanced • Wrap Arguments ( Boolean )

Whether the arguments of the specified process should be enclosed in quotation marks and passed as a single argument:

True - Enclose the arguments in quotation marks and pass as a single argument.

False (default) - Leave the arguments as they are.

Note: The Wrap Arguments input value should be used to avoid possible ambiguity when one of the process arguments contains quotation mark(s).

• Executable Arguments ( String[ ] )

List of arguments to be passed to the executable. If a single argument is to be passed, it should be entered on one line. But if two or more arguments are to be passed, each one should be entered on a separate line.

• Environment Variables Names ( String[ ] )

List of environment variables to be set for the created process.

• Environment Variables Values ( String[ ] )

List of values to be mapped to the environment variables defined for the created process. These values should be mapped to the appropriate environment variable by the sequence in which they are ordered in the input.


Path to the file to which the output stream of the process will be written.

Windows Actions



Path to the file to which the error stream of the process will be written.


Whether to wait for the process to finish its execution:

Specify True to wait for the process to finish execution.

Specify False to not have the process waited for to finish execution.

Setting False essentially allows you to run the executable in the background. Note, however, that this is permitted only on Windows. For non-Windows systems, setting this value to False will cause the step to fail.

Output Values • Return Value ( Long )

Return value of the finished process. This may be an explicit value or a Long parameter.



Start Windows Service This action starts a Windows service by either its service name or its display name.


Input Values

Mandatory


Service or display name of the service to start.

Although case insensitive, the specified name must be the exact service name or display name.

Advanced

• Fail If Not Found ( Boolean )

Whether the action should fail if the service is not found. Default value is True.

• Time To Wait For Service ( Long )

Time in seconds to wait for the service. Default value is 30.

Output Values None

Windows Actions


Stop Windows Service This action stops the Windows service specified by either its service name or display name.


Input Values

Mandatory


Service name or display name of the service to stop.

Although case insensitive, the specified name must be the exact service name or display name.

Advanced

• Time To Wait For Service (Long )

Time in seconds to wait for the service. Default value is 30.

• Fail If Not Found ( Boolean )

Whether the action should fail if the service is not found. Default value is True.

Output Values None



Update Environment Variable This action updates the specified environment variable.

Note: The action is supported only on Windows-based systems.

Input Values

Mandatory

• Variable Name ( String )

Name of the environment variable to be updated.

• Variable Value ( String )

New value to be assigned to the specified environment variable.

Advanced

• Create If Not Exists ( Boolean )

Whether to create the specified environment variable if it does not exist.

Output Values None

Windows Actions


Update Windows Registry Key This action updates the value of the specified Windows registry key.

Note: The action is supported only on Windows systems.

Input Values

Mandatory


Registry key whose value is to be updated.

• New Key Value ( String )

New value to be assigned to the specified registry key.

• Root Hive Name ( RootRegistryHive )

Name of the registry root hive where the registry key to be updated resides.

• Parent Folder Path ( String )

Path to the folder in which the target registry key is located.

Advanced


Type of registry key to retrieve. Valid values are:

SZ

BINARY

DWORD

• Create If Not Exist ( Boolean )

Whether to create the specified registry key if it does not already exist:

Output Values • New Key Value ( String )

New value assigned to the registry key.



Check OS Type This action checks for the running OS Type and matches it to the expected OS Type value.

Input Values

Mandatory

• Expected OS Type ( OSType )

OS Type value to compare against a running OS.

Output Values • Actual OS Type ( OSType )

Actual OS Type.

• Actual OS Type As String( String )

String representation of OS Type.

Check OS Type


Get Environment Variable Value This action retrieves an environment variable value. If an environment variable with a given name was not defined, this action will fail.

Input Values

Mandatory

• Variable Name

Name of the environment variable.

Output Values • Variable Value ( String )

Value of the environment variable.

• Was Found ( Boolean )

Whether the variable was found.



Get Java System Property This action can be used to set the Java system property as a parameter.

Input Values

Mandatory

• Property Name

Java system property name.

Advanced


Whether to fail if the Java system property does not exist.

Output Values • Property Value ( String )

Java system property value.


Chapter 15

Parameter Actions

In This Chapter

Add a Value to an Array ................................................................................................................................. 347 Convert String to Number............................................................................................................................... 349 Extract Column from ResultSet ...................................................................................................................... 350 Extract Value From an Array .......................................................................................................................... 351 Extract Value from ResultSet ......................................................................................................................... 352 Get Array Length ........................................................................................................................................... 353 Get Index of a Value in an Array .................................................................................................................... 354 Remove Value from an Array ......................................................................................................................... 355 Set Parameter Value - Boolean ...................................................................................................................... 356 Set Parameter Value - Integer ........................................................................................................................ 357 Set Parameter Value - String ......................................................................................................................... 358 User Input - Ask For Parameter Value ............................................................................................................ 359 User Input - Choose from Available Options ................................................................................................... 360

Add a Value to an Array This action adds a value to an array at a specified index, starting from 1.

Note: The new value is relevant only at runtime and is not permanently added to the array.

Input Values

Mandatory

• Value

Value to add. Must be the same type as the element type of the input array.

• Input Array

Array to add the value to. Must be the same type as the output array.

Advanced

• Index ( Integer )

Index in the output array in which to insert the value. The first element of the array is at index 1. If left blank, the value is appended to the end of the array.

Chapter 15 Parameter Actions


Output Values • Output Array ( Object[] )

Array with the added value. Must be the same type as the input array.

Convert String to Number


Convert String to Number This action converts the given string to a number. If the string cannot be casted, the action will fail.

Input Values

Mandatory

• Number As String ( String )

Number to convert. If the String does not represent a number, the action will fail.

Output Values • Result As Double ( Double )

Result as Double.

• Result As Integer ( Integer )

Result as Integer.

• Result As Float ( Float )

Result as Float.

• Result As Long ( Long )

Result as Long.



Extract Column from ResultSet This action extracts an Array from a ResultSet using a given column index.

Input Values

Mandatory

• Array

ResultSet on which to perform operation.

• Column

Value of the column to extract. Arrays have a one-based index so first index is 1.

Output Values • Extracted Column ( Object[] )

Specified column.

Extract Value From an Array


Extract Value From an Array This action extracts a value from an array by a given array index.

Note: The index is a 1-based index, so for the first value in an array you should specify index 1. If the array does not have the index specified, the action will fail. If the value is null, an empty string will be returned.

Input Values

Mandatory

• Array ( Object[] )

Array on which to perform the operation.

• Value Index ( Integer )

Index of the value to be extracted.


Value obtained as a result of the extraction.



Extract Value from ResultSet This action extracts a value from a two dimensional array by given column and row indexes.

Note: Arrays have a one-based index, so for first cell you should specify column 1 and row 1.

If the array does not have the column or row specified, the action will fail.

Input Values

Mandatory

• Array

ResultSet on which to perform operation.

• Column

Value of the column to extract. Arrays have a one-based index so first index is 1.

Output Values • Extracted Column ( Object[] )

Specified column.

Get Array Length


Get Array Length This action returns the length of an array.

Input Values

Mandatory

• Array

Array.

Output Values • Length ( int )

Array length.



Get Index of a Value in an Array This action searches for a given value in a given array.

• If found, the first index of the value is returned.

• If not found, -1 is returned.

Index is 1-based index. For the first value in the array, you would get index 1.

Input Values

Mandatory

• Array


• Value

Value to search the array for.

Output Values • Value Index ( Integer )

Index of the value, or -1 if the value is not present in the array.

Remove Value from an Array


Remove Value from an Array This action removes a value from an array at the specified index, starting from 1.

Input Values

Mandatory

• Input Array

Array from which to remove the value. Must be the same type as the output array.

• Index

Index at which to remove the value.

Output Values • Output Array ( Object[] )

Array with the removed value. Must be the same type as the input array.



Set Parameter Value - Boolean This action sets the value of the Boolean parameter to a predefined value during execution.

Note: This action always succeeds.

Input Values

Advanced

• Value ( Boolean )

Use this input to hold the needed value and export it to parameter where needed.

Output Values • Value ( Boolean )

This value receives the value from the parameter value.

Remove Value from an Array


Set Parameter Value - Integer This action sets the value of the Integer parameter to a predefined value during execution.


Input Values

Advanced

• Value ( Integer )


Output Values • Value ( Integer )

This value receives the value from the parameter value.



Set Parameter Value - String This action sets the value of a String parameter to a predefined value during execution.


Input Values

Mandatory

• Value ( String )


Output Values • Value ( String )

This String holds the needed value, and exports it to parameter where needed.

Set Parameter Value - String


User Input - Ask For Parameter Value This action enables the user to enter free text and then store it to a parameter.

Input Values

Mandatory

• Operation Description ( String )

Description of the operation to be displayed. This field displays the string in the HTML container.

Advanced

• Fail On Empty String ( Boolean )

Whether the action will fail if the user entered an empty string.

Output Values • Entered Text ( String )

Entered value.



User Input - Choose from Available Options This action allows the user to choose single or multiple values from a list of available options. The chosen value(s) can be set to a parameter for future use.

Input Values

Mandatory

• Description

Description to be displayed, this field will display string in HTML container.

• Options

List of available options from which to choose.

Advanced

• Allow Multiple Selection ( Boolean )

Allow multiple selection. Select True to allow multiple selections and False to allow a single selection.

When choosing a multiple selection, only the first selection will be saved in the string output; all selected values will be saved in the string array output.

Output Values • Chosen Options ( String[] )

Outcome as indicated by the user as an array.

• Chosen Option ( String )

Outcome as indicated by the user.


Chapter 16

Performance Counter Actions

In This Chapter

Check if Performance Log Exists.................................................................................................................... 361 Create Performance Log ................................................................................................................................ 362 Delete Performance Log ................................................................................................................................ 363 Get Performance Counter Value .................................................................................................................... 364 Get Performance Counter Values................................................................................................................... 365 Get Performance Counter Values Average Over Time ................................................................................... 366 Set Performance Log Counters ...................................................................................................................... 368 Start Performance Log ................................................................................................................................... 369 Stop Performance Log ................................................................................................................................... 370 Update Performance Log Settings.................................................................................................................. 371 Wait for Performance Counter Value .............................................................................................................. 373

Check if Performance Log Exists This action checks if the specified performance log exists.

Input Values

Mandatory

• Performance Log Name ( String )

Performance log name to check.

Advanced

• Fail If Exists ( Boolean )

Whether to fail if the specified performance log does exist.

Output Values None

Chapter 16 Performance Counter Actions


Create Performance Log This action creates a performance log.

Input Values

Mandatory


Performance log name to create.

Advanced

• Fail If Exists ( Boolean )

Whether to fail if the specified performance log exists.

Output Values None

Delete Performance Log


Delete Performance Log This action stops a performance log and then deletes it.

Input Values

Mandatory


Performance log name to delete.

Advanced


Whether to fail if the specified performance log does not exist.

Output Values None



Get Performance Counter Value This action measures the specified performance counter.

Input Values

Advanced

• Initial Delay ( Integer )

Amount of time in seconds to wait before taking the measurement.

• Performance Counter Type ( AvailablePerformanceCounters )

Performance counter to measure.

Output Values • Measurement As Long ( Long )

Measurement, as Long.

• Measurement As String ( String )

Measurement, as String.

• Measurement As Double ( Double )

Measurement, as Double.

Get Performance Counter Values


Get Performance Counter Values This action measures the specified performance counter several times at the specified interval.

Input Values

Advanced




Performance counter type to measure.

• Measurement Interval ( Integer )

Amount of time in seconds to wait between measurements.

• Number Of Measurements ( Integer )

Number of measurements to take.

Output Values • Measurements As Doubles ( Double[] )

Measurements, as Doubles array.

• Measurements As Longs ( Long[] )

Measurements, as Longs array.

• Measurements As Strings ( String[] )

Measurements, as Strings array.



Get Performance Counter Values Average Over Time This action measures the specified performance counter several times at the specified interval and calculates their average result.

Input Values

Advanced




Performance counter type to measure.



• Number Of Measurements ( Integer )

Number of measurements to take.

Output Values • Maximal Measurement As Double ( Double )

Highest measurement, as Double.

• Average Measurement As Double ( Double )

Average of the measurements, as Double.

• Maximal Measurement As Long ( Long )

Highest measurement, as Long.

• Maximal Measurement As String ( String )

Highest measurement, as String.

• Minimal Measurement As Double ( Double )

Lowest measurement, as Double.

• Average Measurement As String ( String )

Average of the measurements, as String.

• Minimal Measurement As String ( String )

Lowest measurement, as String.

Get Performance Counter Values Average Over Time


• Minimal Measurement As Long ( Long )

Lowest measurement, as Long.

• Average Measurement As Long ( Long )

Average of the measurements, as Long.



Set Performance Log Counters This action sets the list of performance counters in the specified performance log.

This action overwrites the current list of counters defined in the specified performance log.

Input Values

Mandatory

• Performance Log Counters ( String[] )

List of performance counters to add to the specified log, for example, \\processor(_Total)\\% processor Time.


Performance log name to which to set counters.

Advanced


Whether the action should fail if the specified performance log does not exist.


Performance log user name. Leave empty for the default user.


Performance log password. This value is relevant only if the user name is set.

Output Values None

Start Performance Log


Start Performance Log This action starts the specified performance log.

Input Values

Mandatory


Performance log name to start.

Advanced



Output Values None



Stop Performance Log This action stops the specified performance log.

Input Values

Mandatory


Performance log name to stop.

Advanced



Output Values None

Update Performance Log Settings


Update Performance Log Settings This action stops the specified performance log if it is running, and updates the specified performance log settings.

Input Values

Mandatory


Performance log name to update.

Advanced


Performance log user name. Leave empty for the default user.

• Command To Run ( String )

Command to run each time the log is closed.


Whether to fail if the specified performance log does not exist.

• Append To Log File ( Boolean )

Whether to append data to the specified log file. This value is not relevant if the Log File Type is SQL.


Performance log file path. If the Log File Type is SQL, specify the DSN in the format dsn_name!log_name.

• Log File Type ( String )

Performance log file type. This value can be either bin, bincirc, csv, tsv, or SQL.

• Collection Start Time ( String )

Performance log start time, in the format M/D/YYYYH:MM:SS, or MANUAL for manual start.

• Max Size ( Integer )

Maximum log file size in MB, or for SQL logs in number of records. Leave empty for maximum values.

• Repeat Daily ( Boolean )

Whether to repeat the specified start and end times on a daily basis. This value is not relevant for MANUAL in either the collection start time or the collection end time.




Performance log password. This value is relevant only if the user name is set.

• Log File Versioning ( PerformanceLogVersioningPattern )

Performance log file versioning pattern. This value can be either nnnnnn, mmddhhmm, or NONE.

• Sample Interval ( String )

Performance log sample interval, in the format HH:MM:SS.

• Collection End Time ( String )

Performance log end time, in the format M/D/YYYYH:MM:SS, or HH:MM:SS for duration, or MANUAL for manual stop.

Output Values

None

Wait for Performance Counter Value


Wait for Performance Counter Value This action measures the specified performance counter several times at the specified interval, and waits until the specified time out for the value to reach the expected value.

Input Values

Mandatory

• Lowest Expected Measurement ( Integer )

Lowest measurement to expect.

• Highest Expected Measurement ( Integer )

Highest expected measurement to expect.

Advanced

• Number Of Measurement Cycles ( Integer )

Number of measurement cycles to take.

• Average Value Comparison Operator ( ComparisonOp )

Comparison operator to use with the expected value, relevant for Average Value strategy only.



• Measurement Strategy ( CounterMeasurementStrategy )

Performance counter measurement strategy to use.

• Measurement Cycles Interval ( Integer )

Amount of time in seconds to wait between measurement cycles.


Performance counter type measurement.



• Number Of Measurements Per Cycle ( Integer )

Number of measurements to take per cycle.

Output Values • Average Measurement As String ( String )

Average of the measurements, as String.



• Maximal Measurement As String ( String )

Highest measurement, as String.

• Minimal Measurement As String ( String )

Lowest measurement, as String.

• Average Measurement As Long ( Long )

Average of the measurements, as Long.

• Maximal Measurement As Long ( Long )

Highest measurement, as Long.

• Minimal Measurement As Long ( Long )

Lowest measurement, as Long.

• Average Measurement As Double ( Double )

Average of the measurements, as Double.

• Maximal Measurement As Double ( Double )

Highest measurement, as Double.

• Minimal Measurement As Double ( Double )

Lowest measurement, as Double.


Chapter 17

Process Actions

In This Chapter

Check if Process is Running .......................................................................................................................... 376 Kill Process .................................................................................................................................................... 377 Kill Process by PID ........................................................................................................................................ 378 Plain TCP String Request .............................................................................................................................. 379 Run Command Line ....................................................................................................................................... 380 Run Process .................................................................................................................................................. 382 Run Windows Process ................................................................................................................................... 384 Telnet Session ............................................................................................................................................... 386 Wait for Processes ......................................................................................................................................... 387

Chapter 17 Process Actions


Check if Process is Running This action checks if a process is running.

On Windows systems, specify the process name according to the executable's file name.

On non-Windows systems, specify the process name as it will appear in the file /proc/PID/status.

Input Values

Mandatory

• Process Name ( String )

Process name; can be case-insensitive. Refer to the Actions Reference help for more details.

Advanced


Whether the expression that the user has entered is regular expression (java Regex). The default is False.

• Match Full Command ( Boolean )

Whether the process name will be matched against the process command line. Relevant to Windows OS only. The default is False. This field is referred as True in Linux

• Should Be Running ( Boolean )

Whether to expect the process to be running. True for running, False for not running.


Whether the process name will be matched against the process command line. Relevant to Windows OS only. The default is False. This field is referred to as True in Linux.

Output Values None

Kill Process


Kill Process This action kills a process given its full/partial name and optionally the owning user.

This action is for MS Windows platform only.

Input Values

Mandatory

• Process Name ( String )

Name of the process to be killed. Enter the exact process name or use regular expressions.

Advanced

• Match Full Command ( Boolean )

Determines whether the process name will be matched against the process command line.

Relevant to Windows OS only.

Default is False. Referenced as True in Linux.


Determines whether the search is case-sensitive or not. The default value is False.


Whether the expression that the user has entered is regular expression (java Regex). The default is False.


Name of the user that started the process.

• Timeout ( long )

Number of seconds to wait for the process to shut down. Default is 60 seconds.

• Fail If No Matches Are Found ( Boolean )

Whether the action should fail in case no processes matched the search. The default is False.

Output Values None



Kill Process by PID This action kills a process given its PID.

This action is supported on MS Windows platform only.

Input Values

Mandatory

• PID ( String )

Process PID.

Advanced


Whether the action should fail in case no such process is currently running. The default is False.

• Timeout ( Long )

Number of seconds to wait for the process to shut down. Default is 60 seconds.

Output Values None

Plain TCP String Request


Plain TCP String Request This action sends a string to a remote TCP socket and captures the output. The output is captured until the designated terminator string is met or the predefined timeout occurs.

Input Values

Mandatory

• Request

String to send.

• Port

Port number of the TCP server.

• Ip Address

IP address of the TCP server.

Advanced

• Terminator ( String )

Terminator string to mark end of receiving.

• Max Size ( int )

Maximum size of the output string, in bytes.


Timeout for receiving, in milliseconds.

Output Values

• Buffer ( String )

Received string.



Run Command Line This step executes the specified command line as if it was executed from command line shell.

It is possible to execute the command line in the background and not wait for it to finish its execution by setting the Wait For Process To Finish input to False.

Input Values

Mandatory

• Command Line

Command line to run.

• Work Directory

Working directory from which to run.

Advanced

• Environment Variables Names ( String[] )

List of environment variables names to be set as the environment variables for the created process. Order should match Environment Variables Values input.


File path to use to write the output stream of the process.


Whether to wait for the process to finish its execution or not: True for wait, False not to wait.

On non-Windows systems, the step will fail if set to False.

• Environment Variables Values ( String [] )

List of environment variables values to be set as the environment variables for the created process. These values should match the names order in the Environment Variables Names input.


File path to use to write the error stream of the process. If not set, then the standard error is redirected to the standard output.

• Time Out Duration ( Long )

Time to wait for the process in seconds. Relevant only if Wait For Process To Finish is set to True.


Expected return value of the finished process. If specified and actual return values are not equal, action will fail.

Run Command Line


Output Values • Std Out Output ( String )





Return value of the finished process.



Run Process This action executes the specified executable.

On Windows only, it is possible to start the process in the background and not wait for it to finish its execution, by setting the Wait For Process To Finish input to False. On non-Windows systems this action will fail if this input is set to False.

Input Values

Mandatory





Advanced




Expected return value of the finished process. If the specified value and the actual return value are not equal, the action will fail.











Run Process




Setting False essentially allows you to run the executable in the background. Note, however, that this is permitted only on Windows. For non-Windows systems, setting this value to False will cause the action to fail.



• Std Out Output ( String )






Run Windows Process This action executes the specified Windows executable.


On Windows only, it is possible to start the process in the background and not wait for it to finish its execution, by setting the Wait For Process To Finish input to False.

Input Values

Mandatory • Executable Path ( String )




Advanced • Wrap Arguments ( Boolean )

Whether the arguments of the specified process should be enclosed in quotation marks and passed as a single argument:

True - Enclose the arguments in quotation marks and pass as a single argument.

False (default) - Leave the arguments as they are.

Note: The Wrap Arguments input value should be used to avoid possible ambiguity when one of the process arguments contains quotation mark(s).









Run Windows Process








Setting False essentially allows you to run the executable in the background. Note, however, that this is permitted only on Windows. For non-Windows systems, setting this value to False will cause the step to fail.





Telnet Session This action provides the ability to create a Telnet session, including authentication and the sending of Telnet commands to the remote Telnet server.

Input Values

Mandatory

• Telnet Host ( String )

Host name of the Telnet server.

• Telnet Commands ( String[ ] )

Telnet commands to be executed once connected.

Advanced

• Telnet Port ( Integer )

Telnet port to be used.

• Prompt ( String )

Prompt to be displayed during the course of the ongoing Telnet session.

• Telnet output ( String )


• Login Prompt ( String )

Prompt to be displayed for logging in, once connected.

• Password Prompt ( String )

Prompt to be displayed for entering the user password, once connected.


User name to be entered when logging on to the Telnet host.

• Login Successful Prompt ( String )

Prompt to be displayed when the login is successful.


User password to be entered when logging on to the Telnet host.

Output Values • Telnet output ( String )


Wait for Processes


Wait for Processes This action checks for each process name in the specified processes list, and retries until the processes either appear in the running processes list or not according to the lookup policy.

On Windows systems specify the process name according to the executable's file name.

On non-Windows systems specify the process name as it will appear in the file /proc/PID/status.

Input Values

Mandatory

• Process Names ( String[] )

User-defined list of process names. Process names are case-insensitive.

Advanced

• Time To Wait Between Retries ( TimeUnit )

Unit of time to be used in setting Time to Wait Between Retries.

• Time Unit For The Total Time To Wait For The Process ( TimeUnit )

Unit of time (in Milliseconds, Seconds, etc.) to be applied when setting the Total Time to Wait For The Process.

• Time Unit To Wait Between Retries ( Long )

Number of time units (in Milliseconds, Seconds, etc.) that should elapse before the check is repeated.

• Processes Lookup Policy ( WaitForProcess$ProcessesLookupPolicy )

Whether the check pertains to the status of all listed processes or, alternatively, to at least one of them.

• Should Be Running ( Boolean )

Whether the process or processes are expected to be running.

True - Processes are expected to be running.

False - Processes are not expected to be running.

• Total Time To Wait For The Process ( Long )

Maximum number of time units to be waited for the process or processes to start running.

Output Values None


Chapter 18

Security Actions

In This Chapter

Authenticate User .......................................................................................................................................... 389 Change Credentials for Windows Service ....................................................................................................... 390 Change Owner of File or Folder ..................................................................................................................... 391 Check if Specific User has Administrative Rights ............................................................................................ 392 Check if Specific User has Permissions on File or Folder ............................................................................... 393 Check if User has Root Credentials ................................................................................................................ 394 IIS - Issue and Assign Server Certificate ........................................................................................................ 395 IIS - Toggle SSL on a Virtual Directory ........................................................................................................... 396 IIS - Toggle SSL on a Website ....................................................................................................................... 397

Authenticate User This action checks the validity of a user's credentials (user name and password). On Windows systems using a domain, specify the domain name with the user name, for example: DOMAIN\Username.

On non-windows systems using a domain, there is no need to specify the domain name.


Input Values

Mandatory

• User Name

User name to authenticate.


User password to authenticate.

Output Values • User Authenticated ( Boolean )

Becomes true if the specified credentials are valid.

Chapter 18 Security Actions


Change Credentials for Windows Service This action changes the start account and password of windows service. This action is supported on Windows systems only.

Input Values

Mandatory


Service name or display name of the service to start, the name specified is case-insensitive, but must be the exact service name or exact display name.


Start account for the service. Should be provided in the form of DomainName\UserName. For local users use: .\LocalUser and for local system account use: LocalSystem.

Advanced





Output Values None

Change Owner of File or Folder


Change Owner of File or Folder This action changes the owner of the specified file or folder. This action will work on Linux or UNIX systems only.

Input Values

Mandatory


Path to the file or folder to change its owner.

• New Owner ( String )

New owner user name.

Advanced


Specifies what to do if the specified file or folder does not exist.


If the resource is not a Folder, it indicates whether to change the ownership recursively.

Output Values None



Check if Specific User has Administrative Rights The action checks if the specified user name is listed in the Administrators group. To check a Domain user, specify the domain name with the user name, for example: DOMAIN\Username. This action supports Windows-based systems only from Windows XP and above.

Input Values

Mandatory


User name on which to verify administrative rights.


User password on which to verify administrative rights.

Output Values None

Check if Specific User has Permissions on File or Folder


Check if Specific User has Permissions on File or Folder This action checks if the specified user credentials has the specified permissions on the specified file or folder.

On Windows systems using the domain, specify the domain name with the user name, for example: DOMAIN\Username.

On non-windows systems using the domain, there is no need to specify the domain name.


Input Values

Mandatory


User name on which to verify permissions. Refer to the Actions Reference help for more details.


Path to the file or folder to check. Can set explicit values or use the File parameter.


User password on which to verify permissions. Refer to the Action Reference help for more details.

Advanced

• Can Exec ( Boolean )

Check if the specified user has execution permissions for the file or folder.

• Can Read ( Boolean )

Check if the specified user has read permissions for the file or folder.

• Can Write ( Boolean )

Check if the specified user has write permissions for the file or folder.

Output Values None



Check if User has Root Credentials This action checks if the user credentials specified are of a user that belongs to the root group. This action supports Unix/Linux systems only.

Input Values

Mandatory


User password on which to verify root rights.


User name on which to verify root rights.

Output Values None

IIS - Issue and Assign Server Certificate


IIS - Issue and Assign Server Certificate This action issues a SSL server certificate for an IIS Web site from Certificate Authority (CA), and stores the issued certificate on the target local machine's certificate store, and assigns it to a Web site.

This action assumes that CA is configured to issue certificates automatically. If CA's policy is to manually approve each certificate request then this action will fail.

It is also assumed that CA's service is running and operational. If CA's service is not operational then an access denied response will be returned.

Input Values

Mandatory

• Web Site Name ( String )

Name of the Web site to be assigned the certificate.

Advanced

• Certificate Authority Name ( String )

Certificate authority service name.

• Certificate Authority Host Name ( String )

Certificate authority's server host name.

• Certificate Common Name ( String )

Certificate Common Name (CN). For a secure connection to be successfully established, the CN must match the intranet/DNS name of the machine on which the Web site is hosted.

Output Values None



IIS - Toggle SSL on a Virtual Directory This action configures IIS to require an encrypted communication link for a Web browser to connect with this directory.

When this option is selected, all data sent to and from this Web virtual directory is encrypted using a certificate.

Input Values

Mandatory

• Enable SSL128 ( Boolean )

Boolean field which configures IIS to require a 128-bit encrypted communication link for a web browser to connect with this Web site, directory, or file.

• Virtual Directory Name ( String )

Name of the virtual directory to be configured opposite IIS.

• Site Name ( String )

Name of the Web site on which the targeted virtual directory resides.

• Enable SSL ( Boolean )

Boolean field which configures IIS to require an encrypted communication link for a web browser to connect with this Web site, directory, or file. When this option is selected, all data sent to and from this Web site is encrypted using a certificate.

Output Values None

IIS - Toggle SSL on a Website


IIS - Toggle SSL on a Website This action configures IIS to require an encrypted communication link for a Web browser to connect with this Website.

When this option is selected, all data sent to and from this Website is encrypted using a certificate.

Input Values

Mandatory


Web site name.


Boolean field which configures IIS to require a 128-bit encrypted communication link for a Web browser to connect with this Website, directory, or file.


Boolean field which configures IIS to require an encrypted communication link for a Web browser to connect with this Website, directory, or file. When this option is selected, all data sent to and from this Website is encrypted using a certificate.

Output Values None


Chapter 19

SNMP Actions

In This Chapter

Send SNMPv1 Trap ....................................................................................................................................... 399 Send SNMPv2c Trap ..................................................................................................................................... 401 Send SNMPv3 Trap ....................................................................................................................................... 402

Send SNMPv1 Trap This action sends a SNMPv1 trap to a designated IP address.

Input Values

Mandatory

• Destination IP

IP address of the trap receiver.

Advanced

• Community Passphrase ( Password )

Community passphrase.

• Trap Generic Type ( Integer )

Trap generic type.

• Destination Port ( Integer )

Port of the trap receiver. Default value is 162.

• Request ID ( Integer )

Request ID.

• Transport Protocol ( TransportProtocol )

Transport protocol. Default value is UDP. Available options are UDP and TCP.

• Variable Bindings ( String )

Chapter 19 SNMP Actions


Variable bindings list. Each line defines a single variable binding and must be in the form of: OID TYPE VALUE String values can contain spaces. For example: 1.3.6.1.4.54 INTEGER 17 1.3.6.1.4.1.2853 STRING a string The available types are: STRING, COUNTER32, COUNTER64, GAUGE, INTEGER, ADDRESS, OID and TIMETICKS.

• Sender OID ( String )

Sender OID.

• Trap Specific Type ( Integer )

Trap specific type.

• Error Index ( Integer )

Error index. Default value is zero (0).

• Variable Bindings Path ( String )

File path for the variable bindings to be used instead of Variable Bindings.Note: If Variable Bindings is set, Variable Bindings Path value is ignored.

• Timestamp ( Long )

Trap timestamp.

• Error Status ( Integer )

Error status. Default value is zero (0).

Output Values None

Send SNMPv2c Trap


Send SNMPv2c Trap This action sends a SNMPv2c trap to a designated IP address.

Input Values

Mandatory

• Destination IP


Advanced


Transport protocol. Default value is UDP. Available options are UDP and TCP




File path for the variable bindings to be used instead of Variable Bindings.Note: If Variable Bindings is set, the Variable Binds Path value is ignored.




Request ID


Variable bindings list. Each line defines a single variable binding and must be in the form of: OID TYPE VALUE String values can contain spaces. For example: 1.3.6.1.4.54 INTEGER 17 1.3.6.1.4.1.2853 STRING a string The available types are: STRING, COUNTER32, COUNTER64, GAUGE, INTEGER, ADDRESS, OID and TIMETICKS



• Community Passphrase ( Password )

Community passphrase.

Output Values None

Chapter 19 SNMP Actions


Send SNMPv3 Trap This action sends a SNMPv3 trap to a designated IP address.

Input Values

Mandatory

• User Name

User name.

• Destination IP


Advanced


Variable bindings list. Each line defines a single variable binding and must be in the form of: OID TYPE VALUE String values can contain spaces.

For example: 1.3.6.1.4.54 INTEGER 17 1.3.6.1.4.1.2853 STRING a string The available types are: STRING, COUNTER32, COUNTER64, GAUGE, INTEGER, ADDRESS, OID and TIMETICKS

• Privacy Passphrase ( Password )

Privacy passphrase. Must be set if Privacy Protocol is set. Should be at least 8 characters long.

• Privacy Protocol ( PrivacyProtocol )

Privacy protocol. Default value is NO_PRIVACY. Available options are NO_PRIVACY, DES, _3DES, AES128, AES192, and AES256.

• Authentication Protocol ( AuthProtocol )

Authentication protocol. Default value is NO_AUTO. Available options are NO_AUTO, MD5. and SHA.


Transport protocol. Default value is UDP. Available options are UDP, and TCP.


File path for the variable bindings to be used instead of Variable Bindings. Note: If Variable Bindings is set, the Variable Bindings Path value is ignored.



• Authentication Passphrase (Password)

Send SNMPv3 Trap


Authentication passphrase. Must be set if Authentication Protocol is set. Should be at least 8 characters long.


Request ID.





Output Values None

Chapter 20

Source Control Actions

In This Chapter

Subversion (SVN) Actions .............................................................................................................................. 405 Team Foundation Server (TFS) 2008 Actions ................................................................................................. 411 Team Foundation Server (TFS) 2010 Actions ................................................................................................. 417

Subversion (SVN) Actions

SVN - Check Out This action checks out a working copy from a repository.

Input Values

Mandatory

• Server Url

Path of a directory on the server. For example, "svn://<host>/serena/newBranch".


Destination path. If the destination path does not exist, the path will be created.

• User Name

SVN server user name.

• Password

SVN server password.

Advanced

• Revision Number ( Long )

Revision number of the working copy you need. The default is the last revision (HEAD).

• Allow Unversioned Obstructions ( Boolean )

If set to True, the update tolerates existing unversioned items that obstruct added paths. Only obstructions of the same type (file or directory) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the update. Default value is False.

Chapter 20 Source Control Actions


If set to False, the update will abort if there are any unversioned obstructing items.

Output Values • Revision ( Long )

SVN revision.



SVN - Commit This action commits changes to a repository. The action allows you to Add/Delete/Modify and commits the changes to the repository.

Input Values

Mandatory

• Working Copy path

Working copy path to be committed. The path can point to a file or a directory. The action works recursively.

• Commit Type

One of the following types:

"Add" to add an item

"Delete" to delete a versioned item

"Modify" to change a versioned item

• User Name


• Password


Advanced

• Commit Message ( String )

Log message.


SVN revision number.

SVN - Create Branch / Tag This action creates, by copying, a new branch / tag on the SVN server.

Input Values

Mandatory

• New Tag Path

Path of the new tag/branch. For example, svn://<host>/nolio/newBranch.

• Server Url

Path of a directory on the server. The directory supplied will be the base to the new branch. For example, svn://<host>/nolio/trunk.

• User Name


• Password


Advanced

• Commit Message ( String )

Log message.




SVN revision.

SVN - Export This action exports the contents of either a subversion repository or a subversion working copy into a 'clean' directory.

Input Values

Mandatory


Destination path. If the destination path does not exist, the path will be created.

• Server Url

Path of a directory on the server. For example, "svn://<host>/serena/newBranch".

• Password


• User Name


Advanced


If set to True, the export will overwrite files or directories. Default value is True.




SVN revision.



SVN - Update This action updates a working copy from a SVN repository.

Input Values

Mandatory

• User Name


• Password


• Path

Path of the versioned item to update. Unversioned paths that are the direct children of a versioned path will cause an update that attempts to add that path; other unversioned paths are skipped.

Advanced

• Allow Unversioned Obstructions ( Boolean )

If set to True, the update tolerates existing unversioned items that obstruct added paths. Only obstructions of the same type (file or directory) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the update. Default value is False.

If set to False, the update will abort if there are any unversioned obstructing items.




SVN revision.

Team Foundation Server (TFS) 2008 Actions



TFS 2008 - Check In This action commits pending changes in the current workspace to the server for Team Foundation Server version control.

Supported OS: Windows.

Input Values

Mandatory

• Path to tf command line interface executable

Installation path of the 'tf' command line interface, for example, 'C:/Program Files/Microsoft Visual Studio 10.0/Common7/IDE/tf.exe', or 'C:/Program Files/Microsoft Visual Studio 9.0/Common7/IDE/tf.exe'.

• Password

Password used to authenticate to Team Foundation Server.

• Username

User name used to authenticate to Team Foundation Server, for example, MyDomain\MyUsername.

• Working Folder

Client side folder of a TFS workspace.

Advanced

• Stdout File Path ( String )

File path to use to write the output stream of the process. If left empty, process output will be ignored

• Comment ( String )

User-provided comment about the check-in. Double-quote (") and single-quote (') characters are not allowed.

• Specific Item ( String )

Specifies target file or folder.

• Timeout Duration ( Long )

Time to wait for the action in seconds. Default is 0 (no timeout).

Output Values None



TFS 2008 - Check Out This action makes a local file writable, and changes its Pending Change status to 'edit' in the workspace.


Input Values

Mandatory



• Specific Item


• Username


• Working Folder


• Password


Advanced


File path to use to write the output stream of the process. If left empty, process output will be ignored.



Output Values None



TFS 2008 - Create Workspace This action creates a new TFS workspace.


Input Values

Mandatory

• Username


• Password


• Workspace Name

Workspace name

• Server

Team Foundation Server 'name' or 'full url', for example, name: 'servername' or fullUrl: 'http://servername:8080' ,'http://192.168.0.49:8080'.

• Working Folder

Client side folder of a TFS workspace



Advanced



• Create Working Folder If Not Exist ( Boolean )

Whether to create a working folder if it does not exist.



Output Values None



TFS 2008 - Delete a Workspace This action deletes workspace on TFS server.


Input Values

Mandatory

• Server

Team Foundation Server 'name' or 'full url', for example, name: 'servername' or fullUrl: 'http://servername:8080' ,'http://192.168.0.49:8080'.



• Username


• Workspace Name

Workspace name.

• Working Folder


• Password


Advanced

• Stdout File Path (String)


• Delete Working Folder (Boolean)

Whether to delete the working folder after workspace on TFS server is deleted. Default is False.

• Timeout Duration (long)


Output Values None



TFS 2008 - Get Version This action retrieves a read-only copy of a file from the Team Foundation Server to the workspace and creates folders on disk to contain it.

Supported OS: Windows

Input Values

Mandatory


Installation path of the 'tf' command line interface, for example: 'C:/Program Files/Microsoft Visual Studio 10.0/Common7/IDE/tf.exe', or 'C:/Program Files/Microsoft Visual Studio 9.0/Common7/IDE/tf.exe'.

• Username

User name used to authenticate with Team Foundation Server, for example: MyDomain\MyUsername.

• Password

Password used to authenticate with Team Foundation Server.

• Working Folder


Advanced




Whether to overwrite all files that do not have the read-only attribute associated with them and that are not checked out during the retrieval. Only files on the server, which are different, will overwrite the files in the local workspace. Default is True.

• Version (String)

Optional version specification. The version specification is the version of the item you want to retrieve.

You can specify a version by:

Date/time (D10/20/2005)

Changeset version (C1256)

Label (Lmylabel)



Latest version (T)

Workspace version (Wworkspacename;owner)

Default is the latest server version.





Output Values None




TFS 2010 - Check In This action commits pending changes in the current workspace to the server for Team Foundation version control.


Input Values

Mandatory



• Username


• Working Folder


• Password


Advanced



• Comment ( String )

User-provided comment about the check-in. Double-quote (") and single-quote (') characters are not allowed.


Time to wait for the action in seconds. Default value is zero (0)



Output Values None



TFS 2010 - Check Out This action makes the local file writable and changes its Pending Change status to 'edit' in the workspace.


Input Values

Mandatory

• Working Folder


• Password


• Username

User name used to authenticate with Team Foundation Server, for example, MyDomain\MyUsername.

• Specific Item



The installation path of the 'tf' command line interface, for example, 'C:/Program Files/Microsoft Visual Studio 10.0/Common7/IDE/tf.exe', or 'C:/Program Files/Microsoft Visual Studio 9.0/Common7/IDE/tf.exe'.

Advanced





Output Values None



TFS 2010 - Create Workspace This action creates a new TFS workspace.


Input Values

Mandatory



• Password


• Username


• Workspace Name

Workspace name.

• Working Folder


• Collection Name

Team Project Collection.

• Team Foundation Server Url

Team Foundation Server Url, for example, 'http://servername:8080/tfs'.

Advanced



• Create Working Folder If Not Exist ( Boolean )

Whether to create a working folder if it does not exist. Default is False.





Output Values None



TFS 2010 - Delete a Workspace This action deletes workspace on TFS server.


Input Values

Mandatory

• Username

User name to authenticate to Team Foundation Server, for example, MyDomain\MyUsername.

• Collection Name

The Team Project Collection.

• Team Foundation Server Url

Team Foundation Server Url, for example, 'http://servername:8080/tfs'.

• Workspace Name

Workspace name.

• Working Folder


• Password




Advanced





• Delete Working Folder ( Boolean )

Whether to delete the working folder, after workspace on TFS server is deleted. Default is False.



Output Values None



TFS 2010 - Get Version This action retrieves a read-only copy of a file from the Team Foundation Server to the workspace and creates folders on disk to contain it.


Input Values

Mandatory

• Working Folder



Installation path of the 'tf' command line interface, for example: 'C:/Program Files/Microsoft Visual Studio 10.0/Common7/IDE/tf.exe', or 'C:/Program Files/Microsoft Visual Studio 9.0/Common7/IDE/tf.exe'.

• Password


• Username

User name used to authenticate with Team Foundation Server, for example: MyDomain\MyUsername.

Advanced


Whether to overwrite all files that do not have the read-only attribute associated with them and that are not checked out during the retrieval. Only files on the server, which are different, will overwrite the files in the local workspace. Default is True.







• Version ( String )

Optional version specification. The version specification is the version of the item you want to retrieve.



You can specify a version by:

Date/time (D10/20/2005)

Changeset version (C1256)

Label (Lmylabel)

Latest version (T)

Workspace version (Wworkspacename;owner)

Default is the latest server version.

Output Values None


Chapter 21

SSH Actions

In This Chapter

Check if File or Folder Exists (SSH) ............................................................................................................... 425 Get File (SSH) ............................................................................................................................................... 427 Put File (SSH) ................................................................................................................................................ 428 Run Command (SSH) .................................................................................................................................... 429

Check if File or Folder Exists (SSH) This action checks if a specified path exists on the target host using SSH protocol.

Input Values

Mandatory

• User Name


• Full Path

Path to the file or folder to check if it exists. Can set explicit values or use the File parameter. Wildcard * can also be used.

• Host Name


Advanced

• Password


• Ssh Port ( int )





Password for private key, if needed.

Chapter 21 SSH Actions



Whether to expect the file or folder to exist. True for exist, False for not exist.

Output Values None

Get File (SSH)


Get File (SSH) This action retrieves a file from a remote host using SSH/SFTP protocol.

Input Values

Mandatory


Full path of the destination on the local host.

• Host Name


• User Name



Full path of the source file to retrieve from the target host.

Advanced







• SSH Port ( int )


Output Values None



Put File (SSH) This action will copy a file to a remote host using SSH/SFTP protocol.

Input Values

Mandatory


Full path of the target file to put on the target host.


Full path of the source file on the local host.

• Host Name


• User Name


Advanced









Output Values None

Get File (SSH)


Run Command (SSH) This action runs the specified command on a remote host using SSH protocol.

Input Values

Mandatory

• Command

Command to run on the target host.

• User Name


• Host Name


Advanced

• Standard Output File Path ( String )

Full path of the file to where the standard output will be written.





• Expected Return Value ( Integer )

Expected return value of the command. If the specified and actual return values are not equal, the action will fail.

• Error Output File Path ( String )

Full path of the file to where the error output will be written.





Output Values • Command Standard Output ( String )

Standard output of the command.



• Return Value ( int )

Return value of the command.

• Command Error Output ( String )

Error output of the command.


Chapter 22

Sun-Solaris Administration Actions

In This Chapter

Package Actions ............................................................................................................................................ 431 Service Actions .............................................................................................................................................. 441

Package Actions

Solaris - Add Package To Spool This action adds a software package to a spool directory.

Note: Solaris version must be 5.10 or higher.

Input Values

Mandatory

• Package Name

Name of package.

• Device Name

Name of device or stream where the package is located. This usually is the path of the package file, or any other stream, containing the package. It might also be a directory name, an external device, or any other device containing the package.

Advanced


Operation timeout in seconds. Default value is 0 - unlimited wait.

• Spool Directory ( String )

Spool directory to add package to. Default value is /var/spool/pkg.

Output Values None

Chapter 22 Sun-Solaris Administration Actions


Solaris - Get Package Information This action retrieves detailed information about the specified software package.


Input Values

Mandatory

• Package ( String )

Package to retrieve information for. This can either be an installed package name or a package file path.

• Package Name or File Path ( PackageType )

Indicates whether the Package parameter contains the name of an installed package or a path to a package file. Values are Name or File_Path.

Advanced



Output Values • Installation Name ( String )

Name of package. This is the installation name of the package used to reference the package.

• Descriptive Name ( String )

Descriptive name of the package. Not to be confused with the installation name of the package.


Short text describing the package.


Installation status of the package.

• Installation Date ( String )

Date and time of the package installation.

• Category ( String )

Comma-separated list of the categories to which the package belongs.

• Version ( String )

Current version of the software package.

Package Actions


• Vendor ( String )

Name of vendor that holds the software copyright.



Solaris - Install Package This action installs a software package from a spool directory.


Input Values

Mandatory

• Package Name

Name of package.

Advanced

• Admin File Path ( String )

Path to a temporary Administration File in case the built-in Administration File is not to be used.




Spool directory from which to install package. Default value is /var/spool/pkg.

Output Values None

Package Actions


Solaris - List All Files In Package This action retrieves a list of all files in a specified package.


Input Values

Mandatory

• Package Name

Name of package.

Advanced



Output Values • File Names ( String[] )

Array containing the names of files in the specified package.



Solaris - List All Packages List all installed software packages, including partially installed packages.


Input Values

Mandatory

None

Advanced



Output Values • Package Names ( String[] )

Array containing the names of installed packages.

Package Actions


Solaris - List Packages Referring To File This action lists all packages referring to a specified file/directory.


Input Values

Mandatory

• Path Name

The path name of file/directory to check.

Advanced



Output Values • Package Names ( String[] )

Array containing the names of packages referring to the specified file/directory.



Solaris - Remove Package From Spool This action removes a software package from a spool directory.


Input Values

Mandatory

• Package Name

Name of package.

Advanced




Spool directory from which to remove package. Default value is /var/spool/pkg.

Output Values None

Package Actions


Solaris - Uninstall Package This action uninstalls a software package.


Input Values

Mandatory

• Package Name

Name of package.

Advanced



Output Values None



Solaris - Verify Package Installation This action verifies whether a software package's content is correctly installed.


Input Values

Mandatory

• Package Name

Name of package.

Advanced



Output Values None

Service Actions


Service Actions

Solaris - Disable Service Instance This action disables, or stops, a service instance.

Note: Solaris version must be 5.10 or higher; service must be an SMF service.

Input Values

Mandatory

• Service Instance

Name of a service instance, such as: svc:/network/ftp:default.

Advanced



• Temporary ( Boolean )

Indicates that the requested action should be temporary. If set to True, the service instance will return to the previous state after the next system boot. Default value is True.

Output Values None



Solaris - Enable Service Instance This action enables, or starts, a service instance.


Input Values

Mandatory


Name of a service instance, such as: svc:/network/ftp:default.

Advanced



• Temporary ( Boolean )

Indicates that the requested action should be temporary. If set to True, the service instance will return to the previous state after the next system boot. Default value is True.

Output Values None

Service Actions


Solaris - Get Service Information This action retrieves details about a specified service instance.


Input Values

Mandatory


Name of service instance, such as: svc:/network/ftp:default.

Advanced



Output Values • Description ( String )

Short description of the service instance.

• Service State ( String )

State of service instances.

• Service Time ( String )

Time of last state change if it occurred within the last 24 hours, otherwise, date of last state change.



Solaris - Get Service Problems This action retrieves a list of failing services, their current state and reason of failure.


Input Values

Mandatory

None

Advanced



Output Values • Service States ( String[] )

Array containing the states of the failed service instances.

• Service Instances ( String[] )

Array containing the names of the failed service instances.

• Reasons ( String[] )

Array containing the reasons for failure of the service instances.

Service Actions


Solaris - Get Service Properties This action retrieves a list of service instance properties, their data types and values.


Input Values

Mandatory



Advanced

• Property Name ( String )

Name of property to retrieve. It can be a specific property name, or for all properties, an empty property name.



Output Values • Property Names ( String[] )

Array containing the names of the properties retrieved.

• Property Values ( String[] )

Array containing the values of the properties retrieved.

• Data Types ( String[] )

Array containing the data types of the properties retrieved.



Solaris - Install Service From Manifest This action installs a service or group of services using a service manifest file.


Input Values

Mandatory

• Service Manifest

Path to service manifest file.

Advanced



Output Values None

Service Actions


Solaris - List All Service Instances This action lists all service instances.


Input Values

Mandatory

None

Advanced



Output Values • Service Instances ( String[] )

Array containing the names of all service instances.



Solaris - List All Service Processes This action lists all processes of a specified service instance.


Input Values

Mandatory



Advanced



Output Values • Service Process Id ( Integer[] )

Array containing PIDs of all processes associated with the service instance.

Service Actions


Solaris - List Service's Dependencies This action enumerates services a specified service depends on.


Input Values

Mandatory



Advanced



Output Values • Depend Services ( String[] )

Array containing the names of service instances on which the specified service depends.



Solaris - List Service's Dependents This action enumerates services that depend on a specified service.


Input Values

Mandatory



Advanced



Output Values • Depend Services ( String[] )

Array containing the names of service instances that depend on the specified service.

Service Actions


Solaris - Refresh Service Instance This action refreshes a service instance.


Input Values

Mandatory



Advanced



Output Values None



Solaris - Restart Service Instance This action restarts a service instance.

Note: Solaris version must be 5.10 or higher, service must be an SMF service

Input Values

Mandatory



Advanced



Output Values None

Service Actions


Solaris - Uninstall Service This action uninstalls a service by removing the service definition from the SMF repository.


Input Values

Mandatory



Advanced



Output Values None


Chapter 23

System Actions

In This Chapter

Check Free Disk Space ................................................................................................................................. 455 Check Number of CPUs ................................................................................................................................. 456 Check OS Type ............................................................................................................................................. 457 Check the Amount of Physical Memory .......................................................................................................... 458 Get Current Date ........................................................................................................................................... 459 Get Current Date and Time ............................................................................................................................ 460 Restart Agent ................................................................................................................................................. 461 Restart Host................................................................................................................................................... 462 Update Environment Variable......................................................................................................................... 463

Check Free Disk Space This action checks the amount of free disk space on the specified drive.

Input Values

Mandatory

• Drive Name ( String )

Name of the partition or disk, for example, 'c:\', '/mnt/hda1','/tmp'.

• Expected Disk Space ( Long )

Number of free megabytes (MBs) to compare with the actual free MBs of disk space.

Advanced


Comparison operator to apply on actual value versus expected. Options can be selected from the list.

Output Values • Actual Disk Space ( Long )

Actual disk space as measured in the host.

Chapter 23 System Actions


Check Number of CPUs This action checks the amount of CPUs on the host in which the action runs.

Input Values

Mandatory

• Expected Number Of CPUs ( int )

Number of CPUs for which to check.

Advanced



Output Values • Actual Number Of CPUs ( int )

Actual number of CPUs measured in the host.

Check OS Type


Check OS Type This action checks for the running OS Type and matches it to the expected OS Type value.

Input Values

Mandatory

• Expected OS Type ( OSType )

OS Type value to compare against a running OS.

Output Values • Actual OS Type ( OSType )

Actual OS Type.

• Actual OS Type As String( String )

String representation of OS Type.



Check the Amount of Physical Memory This action checks the total amount of physical memory.

Input Values

Mandatory

• Expected Memory Amount ( Long )

Amount of total physical memory (in MB) to compare with actual MBs of RAM.

Advanced



Output Values • Actual Memory Amount ( Long )

Amount of actual total physical memory (in MB).

Get Current Date


Get Current Date This action can be used to set the current date as a parameter. The resulting date will be the time when this action is executed.

Input Values

Advanced

• Time Unit ( TimeUnit )

Time unit to which Amount To Add refers.


String format to use for returning the date and time. The default is yyyy/MM/dd HH:mm:ss.

• Amount To Add ( Long )

Number of milliseconds to add to the Date As Long return value (to subtract, use a negative number).

Output Values • Date As String ( String )

Date and time are returned as a string using the format specified by the Date Format input value.

• Date As Long ( Long )

Date and time are returned as the number of milliseconds that have elapsed from 00:00:00 GMT, January 1, 1970 until the action was executed.



Get Current Date and Time This action provides information on the current Data and Time of the machine on which it is executed.

Input Values

Advanced • Time Format ( String )

Time format to use to set formatted time.


Date format to use to set formatted date.

Output Values • Formatted Date ( String )

Current date formatted as a string.

• Time In Millis ( Long )

Number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date.

• Formatted Time ( String )

Current time formatted as a string.

• Current Date ( Date )

Current date as a date object.

Restart Agent


Restart Agent This action restarts the agent on which this action is run.

This action is supported on Linux, Unix, and Windows systems.

Input Values

Advanced

• Update Properties Path ( String )

Path of the update properties file. Can set explicit values or use the File Parameter.

Output Values None



Restart Host This action restarts the local server on which this action is run.

This action is supported on Linux, Unix, and Windows systems.

Input Values

Advanced

• Reboot Command ( String )

Command line to execute for reboot in POSIX systems. Leave empty for autodetection.

• Event Log Description ( String )

(Windows only) This text will be entered in the Windows Event Log as the description for the Restart operation.

Output Values None

Update Environment Variable


Update Environment Variable This action updates the specified environment variable.

Note: The action is supported only on Windows-based systems.

Input Values

Mandatory

• Variable Name ( String )

Name of the environment variable to be updated.

• Variable Value ( String )

New value to be assigned to the specified environment variable.

Advanced

• Create If Not Exists ( Boolean )

Whether to create the specified environment variable if it does not exist.

Output Values None


Chapter 24

Text Actions

In This Chapter

Add Text to a File ........................................................................................................................................... 465 Extract Regular Expression Text from String .................................................................................................. 467 Extract Text from a File .................................................................................................................................. 468 Find Text in File ............................................................................................................................................. 469 Find Text in HTML ......................................................................................................................................... 471 Log to File on Serena Center ......................................................................................................................... 473 Read String Array from Text File .................................................................................................................... 474 Read String from Text File ............................................................................................................................. 475 Replace Text in File ....................................................................................................................................... 476 Replace Text in Multiple Files......................................................................................................................... 477 Update Value in Array (String)........................................................................................................................ 478 Write Array to Text File .................................................................................................................................. 479

Add Text to a File This action inserts text into a file.

It is possible to specify text that is to be searched in the file, and the Text To Add input will be added after it.

If no search text is specified, the text is added at the end of the file.

Input Values

Mandatory


Path to the file in which the text is to be added.

• Text To Add ( String )

Text that is to be added. Can set the explicit value, or use one of the string parameters, except for the String Array Parameter.

Advanced

• Add With New Line ( Boolean )

Whether to add the text with a New Line character.

Chapter 24 Text Actions


• Is Regex ( Boolean )

Whether to treat Add After This Text as a regular expression.

• Add After This Text ( String )

Specified text to search for in the file, after which the specified Text To Add input is added.

• Add Text At The Beginning ( Boolean )

Whether to add the text at the beginning. It is True for the beginning, and False for the end. It is relevant only if Add After This Text is empty.

• Create File If Not Exist ( Boolean )

Create the file if it does not exist.

Output Values None

Add Text to a File


Extract Regular Expression Text from String This action extracts text from a string based on a regular expression.

Input Values

Mandatory

• Source String

String from which to extract the text.

• Regular Expression

Regular expression to use.

Advanced


Template for extraction result. If no template is given, result will not be modified. Use $n for group n in regular expression input. Refer to action's help for an example. To get character $ type \$.

• Ignore If Not Found ( Boolean )

Whether to ignore if the text is not found.

Output Values • Target Strings ( String[] )

Array of the text occurrences matched by the regular expression.

• Target String ( String )

Text that is matched by the specified regular expression.

• Splitted String ( String[] )

String is split according to the provided regular expression.



Extract Text from a File This action extracts text from a given file by a given regular expression and stores found matched groups as defined by the result template input. The extraction result should be stored as a String Parameter.

For example: If the regular expression is "url=http://(server\d)/(path\d)",

the result template is "$2 on $1", and the file contains the line "url=http://server8/path5",

the extraction result will be "path5 on server8".


Input Values

Mandatory

• Regular Expression ( String )

Text to find in the file. To search using regular expression placeholders, use the standard regular expression conventions. See http://www.regular-expressions.info for more details about regular expressions syntax.


File from which text is to be extracted.

Advanced


Template for the extraction result. Use $n for group n in the regular expression input. Refer to the Actions Reference help for an example. To get character $ type \$.


Result of the extraction operation.

Find Text in File


Find Text in File This action finds a word or a string in the specified text file.

Note: For searches that use regular expressions, the maximum size of a file that can be searched in is 10 MB.

Input Values

Mandatory


Path to the file in which to search.


Text to find in the specified file.

To search using regular expressions, set Regular Expression input parameter to True.


Advanced

• Regular Expression ( Boolean )

Whether to search using Regular Expressions. If True, the Text to Find input will be considered as a regular expression.

• File Character Set ( String )

Character set of the target file, if known; for example: Unicode or Windows-1255.

If this value is left blank, the search will first be performed using the system's default character set. If, during this initial search, the searched for text is not found, another attempt will be made using Unicode.


Whether to consider character case when performing the search:

True - Character case-sensitive when performing the search.

False (default) - Character case-insensitive when performing the search.

• Text Should Exist ( Boolean )

Whether to expect the text to be found or not to be found:

True (default) - It is expected that the text will be found.

False - It is not expected that the text will be found.

• Timeout ( int )



Timeout to wait before failing. Action will retry until success or timeout.

Output Values • Text To Find ( String )

Text to find in the file. To search using Regular Expressions, set Regular Expression input parameter to True.


Find Text in HTML


Find Text in HTML This action checks for the existence of a given text in the HTML that is retrieved from the specified URL.

Input Values

Mandatory

• Target URL ( String )

URL from which the HTML text is to be retrieved.

• Text To Match ( String )

Text to be searched for in the retrieved HTML.

Advanced

• Maximum Time To Wait ( int )

Maximum amount of time (in seconds) to wait before repeating the retrieval and search operations. This input value is relevant only if Repeat Until Found is set to True.


User name to use (leave empty to not use any user name).

• Is Unicode ( Boolean )

Whether the HTML that is to be retrieved from the target URL is written in Unicode:

True (default) - Written in Unicode.

False - Not written in Unicode.

• Is Post ( Boolean )

Whether to use the POST or the GET method.

True - Use the POST method.

False (default) - Use the GET method.

• Parameters ( String[] )

URL parameters when the method is POST HTTP. Each line in the array should be in the form of key=value.

• Time To Wait Between Retries ( Long )

Amount of time (in seconds) to wait before repeating the retrieval and search operations. This input value is relevant only if Repeat Until Found is set to True.


Whether to use Preemptive Authentication when using the user name to login to the Web site.



• Repeat Until Found ( Boolean )

Whether to repeatedly retrieve the HTML from the specified URL until the searched-for text is matched.


User password to use.

Output Values None

Log to File on Serena Center


Log to File on Serena Center This action allows the user to write a message to a CSV or text file on the Serena Center machine.

The CSV file format is: [time stamp],[agent],[message].

The text file format is: [time stamp]<tab>[agent]<tab>[message].

Input Values

Mandatory

• File Path

Path of a file. If the file does not exist, it will be created.

Advanced

• File Type ( FileType )

File type of log to create.

If the File Type is TXT, the delimiter value is a tab.

If the File Type is CSV, the delimiter value is a comma, which wraps each value, meaning that the last character in the string to output is a comma.

• Message ( String )

Message to be logged.

• Messages array ( String [] )

Array of messages. The array values will be separated by the file delimiter.

Output Values None



Read String Array from Text File This action reads a specified text file and inserts every line of the file as an element of a new array.

Input Values

Mandatory



Output Values • Result Array ( String[] )

Resulting array.

Read String from Text File


Read String from Text File This action reads a specified text file. This action can be used to read a file's contents into a String Parameter.

Note: The file size should not exceed 100 KB.

Input Values

Mandatory



Output Values • Result String ( String )

Resulting string.



Replace Text in File This action replaces a string in a text file.

This action will fail if either the specified file does not exist, or if the text was not found.


Input Values

Mandatory


Text to find in the file. In order to search using regular expressions, set the Is Regular Expression input to True (see below). Refer to http://www.regular-expressions.info for more details.


Path to the file in which text is to be replaced.

• Text To Replace ( String )

Replacement text for all occurrences of the Text To Find input found in the specified file.

Advanced







Output Values None

Replace Text in Multiple Files


Replace Text in Multiple Files This action replaces a string that may recur in multiple text files. All occurrences of the string are replaced in each file.

Note: This action will fail if even one of the specified files does not exist.


Input Values

Mandatory

• Text to Replace ( String )

Replacement text for all occurrences of the Text To Find input found in the specified files.

• File Paths ( String[] )

Paths to the text files.


Text to find in the specified files. To search using regular expressions, set the Is Regular Expression input to True (see below). For more details, see http://www.regular-expressions.info/.

Advanced





• May Not Contain The Text ( Boolean )

Whether the action should pass or fail if the Text to Find was not found in some of the specified files:

Select True if not all the files must contain the Text to Find.

Select False if all files must contain the Text to Find.



Output Values None



Update Value in Array (String) This action updates a value in an array using given array index.

Notes:

Index is 1-based index. For first value in array, specify index 1. If the array does not have the index specified, the action will fail.

Array must already exist and cannot be null.

Input Values

Mandatory

• Index

Index of the value to update.

• New Value

New value to set.

• Array


Output Values • Array ( String[] )

Array on which operation was performed.

Write Array to Text File


Write Array to Text File This action writes a specified array to a specified file.

Input Values

Mandatory

• Filename

File name to which to write the array.

• Array

Array to be written to the specified file.

Advanced

• Create File If Not Exists ( Boolean )

Whether to create the file, if it does not exist.

• Append ( Boolean )

Set to True to append to file, and False to rewrite the file.

Output Values None


Chapter 25

VMWare Actions

In This Chapter

Cluster Actions............................................................................................................................................... 481 Datacenter Actions......................................................................................................................................... 484 Host Actions .................................................................................................................................................. 490 Network Actions ............................................................................................................................................. 499 Template Actions ........................................................................................................................................... 527 Virtual Machine Actions .................................................................................................................................. 537

Cluster Actions

VM - Add ESX Host To Cluster This action adds a new ESX host to a specified VMware cluster.

Input Values

Mandatory

• Server

Vcenter/esx server name. It can be IP address or name of the Vcenter/esx server where the host is located.

• Username

User name of the VMware account

• Cluster Name

Name of the cluster.

• Password

Password of the VMware account.

• Host Name

DNS name or IP address of the host system.

• Host User Name

Administration account on the host.

Chapter 25 VMWare Actions


• Host Password

Password for administration account.

Advanced

• Add Connected ( Boolean )

Flag to specify whether or not the host should be connected immediately after it is added.

• Protocol ( String )

Protocol. It can be either "http" or "https".

• Host Port ( Integer )

Port number for the connection. If this is not specified, the default port number is used.


If this flag is set to True, then the connection succeeds even if the host is already being managed by another vCenter.

• Resource Pool Name ( String )

Resource pool for the root resource pool from the host.

• Ssi Thumbprint ( String )

Thumbprint of the SSL certificate, which the host is expected to have.

• Use Certificate ( Boolean )

Whether SSL certificates are used.


Port number.

Output Values None

Cluster Actions


VM - Get Clusters This action lists all VMware Clusters in the inventory tree.

Input Values

Mandatory

• Server

vCenter/esx server name. It can be IP address or name of the vCenter/esx server where the host is located.

• Password


• Username

User name of the VMware account.

Advanced




Port number.



Output Values • Cluster Names ( String[] )

Array of cluster names.



Datacenter Actions

VM - Add ESX Host To VCenter This action adds a new ESX host to a specified vCenter.

Input Values

Mandatory

• Host User Name

Administration account on the host.

• Host Password


• Password


• Server


• Host Name


• Username


Advanced

• VCenter Name ( String )

Name of the vCenter.


Port number.





• Ssi Thumbprint ( String )

Thumbprint of the SSL certificate, which the host is expected to have.

Datacenter Actions


• Add Connected ( Boolean )

Flag to specify whether or not the host should be connected immediately after it is added.


If True, the connection succeeds even if the host is already being managed by another vCenter.

• Vm Swap Placement ( String )

Setting for the swapfile placement policy (available values are "hostLocal", "inherit", "vmDirectory").



Output Values None



VM - Get Datacenters This action lists all Datacenters in the inventory tree.

Input Values

Mandatory

• Username


• Server

The Vcenter/esx server name. It can be the IP address or name of the Vcenter/esx server where the host is located.

• Password


Advanced






Port number.

Output Values • Dc Names ( String[] )

List of all datacenter names.

Datacenter Actions


VM - Get Datastores This action lists all Datastores in a specified Datacenter or inventory tree.

Input Values

Mandatory

• Server


• Password


• Username


Advanced


Port number.





• Dcname ( String )

Datacenter name. Set this name only for vCenter. If not set, datastores are enumerated in the inventory tree.

Output Values • Datastore Names ( String[] )

List of datastores.



VM - Get Hosts This action lists all ESX Hosts in a specified Datacenter or the inventory tree.

Input Values

Mandatory

• Username


• Server


• Password


Advanced




Port number.




Datacenter name. Set the name only for vCenter. If is not set, all host is enumerated in the inventory tree.

Output Values • Host Names ( String [] )

List of host system names.

Datacenter Actions


VM - Remove Host This action deletes a specified ESX Host from the cluster.

Input Values

Mandatory

• Password


• Server


• Host Name


• Username


Advanced


Port number.

Protocol ( String )




Output Values None



Host Actions

Maintenance Actions

VM - Disconnect Host

This action disconnects an ESX host from vCenter and instructs the server to stop sending heartbeats.

Input Values

Mandatory

• Host Name


Username


• Password


• Server


Advanced




Port number.



Output Values None

Host Actions


VM - Exit Host From Maintenance

This action terminates a maintenance mode of a specified ESX host.

Input Values

Mandatory

• Timeout

Number of seconds to wait for the exit maintenance mode to succeed.

• Username


• Host Name


• Password


• Server


Advanced




Port number.



Output Values None



VM - Put Host To Maintenance

This action places a specified ESX host into maintenance mode.

Input Values

Mandatory

• Password


• Timeout

Timeout value for entering maintenance mode operation.

• Server


• Host Name


• Username


Advanced

• Evacuate Powered Off Vms ( Boolean )

If set to True, the task will not succeed unless all powered-off virtual machines have been manually reregistered.




Port number.



Output Values None

Host Actions


VM - Reconnect Host

This action reconnects a specified ESX host. This action will also reinstall VM agent and reconfigure the ESX host if needed.

Input Values

Mandatory

• Host User Name

Administration account on the host system.

• Host Password


• Password


• Server


• Username


• Host Name


Advanced


Port number.



• New Host Name ( String )

New DNS name or IP address of the host system.


Whether or not the host should be connected immediately after it is added.

• Ssl Thumbprint ( String )

The thumbprint of the SSL certificate, which the host is expected to have.







Output Values None

Host Actions


Power Actions

VM - Power Down Host To Standby

This action puts the ESX host in standby mode.

Input Values

Mandatory

• Password


• Timeout

If host heartbeats are still coming after timeout seconds, the host is declared timed-out, and the task is assumed failed.

• Server


• Username


• Host Name


Advanced

• Evacuate Powered Off Vms ( Boolean )

If set to True, the task will not succeed unless all powered-off virtual machines have been manually reregistered.




Port number.



Output Values None



VM - Power Up Host From Standby

This action takes a specific ESX Host out of Standby Mode.

Input Values

Mandatory

• Timeout

If heartbeats signal isn't received from the host for timeout seconds, the host is declared timed out, and the task is assumed failed.

• Server


• Password


• Username


• Host Name


Advanced


Port number.





Output Values None

Host Actions


VM - Reboot Host

This action reboots a specific ESX host system.

Input Values

Mandatory

• Force

Whether the host should be rebooted regardless of whether it is in maintenance mode.

• Host Name


• Username


• Password


• Server


Advanced






Port number.

Output Values None



VM - Shutdown Host

This action shuts down as ESX server.

Input Values

Mandatory

• Username


• Force

Whether the host system should be shut down regardless of whether it is in maintenance mode.

• Password


• Server


• Host Name


Advanced




Port number.



Output Values None

Network Actions


Network Actions

VM - Add Host Virtual Adapter This action adds a new host Virtual Adapter to a specified port group of the ESX host network system. If Dhcp is True, then IpAddress and SubnetMask are ignored.

Input Values

Mandatory

• Server


• Username

User name of the VMware account

• Port Group Name

Name of the port group.

• Host Name

Name of the host system.

• Password

Password of the VMware account

Advanced

• Ip Address ( String )

IP address.


Port number

• Dhcp ( Boolean )

True if DHCP is enabled.


Name of the datacenter. Set this name only for vCenter. If it is not specified, the inventory tree is used for object searching.







• Subnet Mask ( String )

Subnet mask.

• Mac ( String )

MAC address of the virtual card.

Output Values • Host VNIC Name ( String )

Name of the host virtual adapter.

Network Actions


VM - Add Port Group This action adds a new Virtual Switch port group to the specified ESX host network system.

Input Values

Mandatory

• Switch Name

Name of the virtual switch.

• Port Group Name

Name of a new port group.

• Host Name


• Server


• Username


• Password


Advanced


Protocol. It can be either "http" or "https"


Port number

• V Lan ID ( Integer )

Virtual LAN ID, default value is "0" means the port group is not associated with a VLAN







Output Values None

Network Actions


VM - Add Virtual Ethernet Card To VM This action adds a new Virtual Ethernet Card to a specified Virtual Machine.

Input Values

Mandatory

• Server


• Password


• Username


• Vmname

Virtual machine name.

Advanced





• Port Group Name ( String )

Name of the port group. It should be existed network name. If this name is null, the virtual adapter is added to the virtual machine but does not connect to any existing networks.


Port number.

• Adapter Type ( NetworkAdapterType )

Virtual network adapter type.

Output Values • Device Key ( Integer )

Key of the virtual Ethernet card.



VM - Add Virtual Switch This action adds a new Virtual Switch to an ESX host network system.

Input Values

Mandatory

• Password


• Server


• Host Name


• Num Ports

Number of ports that the virtual switch currently has.

• Switch Name


• Username


Advanced







• Mtu ( Integer )

Maximum transmission unit (MTU) associated with the virtual switch, in bytes.


Port number.

Network Actions


Output Values None



VM - Get All Host Virtual Adapters This action lists all host Virtual Adapters of a Host Network system.

Input Values

Mandatory

• Host Name


• Password


• Username


• Server


Advanced






Port number.



Output Values • Host VNIC Names ( String[] )

Names of the host virtual adapters.

Network Actions


VM - Get All Virtual Switches This action lists all Virtual Switches of a host Network System Object.

Input Values

Mandatory

• Username


• Server


• Password


• Host Name


Advanced








Port number.

Output Values • Switch Names ( String[] )

Names of the virtual switch.



VM - Get All VM Virtual Ethernet Cards This action lists all Virtual Ethernet Cards of a specified Virtual Machine.

Input Values

Mandatory

• Password


Username


• Vmname


• Server


Advanced




port number.



Output Values • Device Keys ( Integer[] )

Keys of Virtual Ethernet Cards.

Network Actions


VM - Get Host Virtual Adapter Config This action retrieves the configuration of a specified ESX host virtual adapter in the ESX Host Network System.

Input Values

Mandatory

• Host VNIC Name


• Password


• Server

vCenter/esx server name. It can be the IP address or name of the vCenter/esx server where the host is located.

• Host Name


• Username


Advanced

• DC Name ( String )

Name of the datacenter. Set this name only for vCenter. If not specified, the inventory tree is used for object searching.


Whether SSL certificates are used. Default value is False.


Port number. Default value is 8333.


Protocol used. It can be either "http" or "https". Default value is http.

Output Values • Dhcp ( Boolean )

Whether or not DHCP (dynamic host control protocol) is enabled. If set to True, the Ip Address and the Subnet Mask strings cannot be set explicitly.



• Port Group Name ( String )

Name of port group to which virtual nic is connected.

• Mac ( String )

Media access control ( MAC ) address of the virtual network adapter.


Subnet mask.

• Port Of Nic ( String )

Port on the port group that the virtual network adapter is using when it is enabled.


IP address currently used by the network adapter. All IP addresses are specified using IPv4 dot notation.

Network Actions


VM - Get Port Group Config This action retrieves the configuration of a specified Port Group of the ESX Host Network System.

Input Values

Mandatory

• Host Name


• Port Group Name


• Server


• Password


• Username


Advanced








Port number.

Output Values • Virtual Switch Name ( String )

The name of the virtual switch that contains specified port group.

• Vlan ID ( Integer )

The VLAN ID for ports using specified port group.



• Connected Type ( String[] )

The type of component connected to a port group.

Network Actions


VM - Get Virtual Ethernet Card Config This action retrieves the configuration of a specified Virtual Ethernet Card of the specified Virtual Machine.

Input Values

Mandatory

• Device Key

Key of the virtual Ethernet Card.

• Vmname


• Password


• Server


• Username


Advanced






Port number.

Output Values • Adapter Name ( String )

Virtual Ethernet Card name.

• Mac Address ( String )

MAC address assigned to the virtual Ethernet Card.

• Wake On Lan Enabled ( String )

Whether wake-on-LAN is enabled on the virtual Ethernet card.



• Connected ( String )

Whether the device is currently connected.

• Address Type ( String )

MAC address type.

• Allow Guest Control ( String )

Flag to allow the guest to control whether the virtual Ethernet card is connected.

• Start Connected ( String )

Flag to specify whether or not to connect the virtual Ethernet card when the virtual machine starts.

• Network Name ( String )

Network name.

• Adapter Type ( NetworkAdapterType )

Ethernet adapter type.

Network Actions


VM - Get Virtual Switch Config This action retrieves the configuration of a specified Virtual Switch in the ESX Host Network System.

Input Values

Mandatory

• Username


• Password


• Host Name


• Server


• Switch Name


Advanced






Port number.



Output Values • Port Group Names ( String[] )

List of port groups configured for this virtual switch.

• Num Ports ( Integer )

Actual number of ports which were created on the specified Virtual Switch.



• Nic Names ( String[] )

Set of physical network adapters associated with this bridge.

• Mtu ( Integer )

Maximum transmission unit (MTU) associated with this virtual switch in bytes.

Network Actions


VM - Remove Host Virtual Adapter This action removes a host virtual adapter from a specified port group of the host network system. Device name or port group name should be specified. The priority of the parameters: first we look for virtual NIC by device name (if the parameter is not null), otherwise by port group name.

Input Values

Mandatory

• Host VNIC Name


• Password


• Server


• Username


Host Name


Advanced


Port number.







Port Group Name ( String )




Output Values None

Network Actions


VM - Remove Port Group This action removes a specified Virtual Switch Port Group.

Input Values

Mandatory

• Host Name


• Password


Server


• Port Group Name

The name of the port group

• Username


Advanced






Port number.



Output Values None



VM - Remove Virtual Ethernet Card From VM This action removes a specified Virtual Ethernet Card from a specified Virtual Machine.

Input Values

Mandatory

• Device Key

Key of the Virtual Ethernet Card.

• Server


• Password


• Username


• Vmname


Advanced


Port number.





Output Values None

Network Actions


VM - Remove Virtual Switch This action removes virtual switch from the host network system.

Input Values

Mandatory

• Host Name


• Username


• Switch Name


• Server


• Password


Advanced








Port number

Output Values None



VM - Update Host Virtual Adapter This action updates a specified Host Virtual Adapter.

Input Values

Mandatory

• Password


• Server


• Username


• Host VNIC Name


• Host Name


Advanced


IP address.


Subnet mask.








Port number.

• Dhcp ( Boolean )

Network Actions


True if DHCP is enabled.

• Mac ( String )

MAC address of the virtual card.

Output Values None



VM - Update Port Group This action updates a specified Virtual Switch Port Group.

Input Values

Mandatory

• Server


• Password


• Port Group Name

Name of the port group

• Host Name


• Username


Advanced





• New Port Group Name ( String )

New name of the port group


Port number.



Output Values None

Network Actions


VM - Update Virtual Switch This action updates a Virtual Switch.

Input Values

Mandatory

• Switch Name


• Username


• Server


• Host Name


• Password


Advanced

• Mtu ( Integer )

Maximum transmission unit, in bytes.


Port number.



• Num Ports ( Integer )

Total number of ports.







Output Values None

Template Actions


Template Actions Template Actions include:

• Clone (on page 529)

• Convert (on page 529)

• Deploy (on page 531)

Clone Action

VM - Clone VM

This action creates a clone of the Virtual Machine.

Input Values

Mandatory

• Vm New Name

Name of a new cloned virtual machine.

• Username


• Datastore Name

Name of target datastore.

• Datacenter Name

Name of target datacenter.

• Server


• Vmname


• Password


Advanced

• Is Power On ( Boolean )

Whether VM has to power on when host is powered on.



• Is Template ( Boolean )

Whether cloned virtual machine should be set as template. Setting this parameter to True will cause Is Power On value to be ignored.






Port number.

Output Values None

Template Actions


Convert Actions

VM - Convert Template To VM

This action converts a template to a Virtual Machine.

Input Values

Mandatory

• Server


• Vmname


• Password


• Username


Advanced





• Pool Name ( String )

Name of resource pool.


Port number

• Host Name ( String )


Output Values None



VM - Convert VM To Template

This action converts a Virtual Machine into a template.

Input Values

Mandatory

• Server


• Vmname


• Username


• Password


Advanced


Port number.





Output Values None

Template Actions


Deploy Actions

VM - Create Custom VM

This action creates a Virtual Machine according to the parameters. The action adds existing disks and creates new virtual disks. The action also registers the new VM to the resource pool and/or ESX host.

Input Values

Mandatory

• Vm Name


• Username


• Password


• Server


• Datastore Name

Datastore name.

Advanced

• Network Adapter Names ( String[] )

Name of the virtual NIC Adapters.




Port number.



• Scsi Adapter ( VirtualDiskAdapterType )

Type of the SCSI adapter.

• Connect Network At Power On ( Boolean[] )

Set to True if it needs the virtual network adapter to connect when VM is powered on.



• Disk Sizes ( Long[] )

Size of new virtual disks, in MB.

• Guest Id ( String )

Guest OS Identifier.

• Memory Size ( Long )

VM memory size, in MB.

• Disk File Paths ( String[] )

Path to the existing Virtual Disks (folder name and file name). The format of path to virtual disk file is [datastore]_folder/diskfile.

• Datacenter Name ( String )

Datacenter name. Set this name only for vCenter.

• Thin Provisioned ( Boolean[] )

Set to True if it needs to allocate and commit disk space on demand for new virtual disks. If this parameter is provided, it must have the same size as new Disk Sizes array.


Name of the Resource Pool.

• Vm Annotation ( String )

Annotation to the VM.

• Network Names ( String[] )

Name of VM Networks.

• Cpu Number ( Integer )

Number of virtual processors.

• Disk Modes ( String[] )

Mode of new virtual disks: persistent, independent_persistent, independent_nonpersistent. If disk modes are provided, they must have the same size as new Disk Sizes array.

Output Values None

Template Actions


VM - Create Typical VM

This action creates a Typical Virtual Machine.

Input Values

Mandatory

• Password


• Vmname


• Server


• Username


• Ds Name

Datastore name.

Advanced


Datacenter name. Set this name only for vCenter.


Port number.

• Disk Size ( Long )

Virtual Disk size, in MB.



• Nic Name ( String )

Virtual network adapter name. If it is not set, no network card will be inserted.

• Net Name ( String )

Virtual network name. If it is not set, no network card will be inserted.






The protocol. It can be either "http" or "https".


The Guest OS Identifier.

Output Values None

Template Actions


VM - Deploy VM From Template

This action deploys a Virtual Machine from an existing Template.

Input Values

Mandatory

• Server


• Datacenter Name

Name of the datacenter.

• Vmname


Password

Password of the VMware account/

• Vm New Name

Name of a new cloned virtual machine.

• Datastore Name

Name of the datastore for saving the cloned machine.

• Username


Advanced






Name of the resource pool.


Port number.





Output Values None

Virtual Machine Actions


Virtual Machine Actions Virtual Machine Actions include:

• Administrate (on page 537)

• Migrate (on page 553)

• Power (on page 558)

• Snapshots (on page 565)

Adminstrate Actions

VM - Add Existing Virtual Disk to VM

This action adds an existing Virtual Disk to a specified Virtual Machine.

Input Values

Mandatory

• Disk File Path

Path to the existing virtual disk. The format of path to virtual disk file is [datastore]_folder/diskfile.

• Server


• Username


• Vmname


• Password


Advanced


Port number.

• Scsi Controller Name ( String )

Name of the SCSI controller. If SCSIControllerName is not set, the first Virtual SCSI Controller will be selected.







Output Values None



VM - Add Virtual CD to VM

This action adds a new Virtual CDROM to a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Ds Name

Name of the datastore that contains image file.

• Server


• Username


• Iso File

Name of the ISO file. The subfolder of the image file is the subfolder of the specified virtual machine.

• Password


Advanced




Port number.



Output Values • Device Key ( Integer)

Key of the CD.



VM - Add Virtual Disk To VM

This action adds a new Virtual Disk to a specified Virtual Machine.

Input Values

Mandatory

• Disk Name

Name of a new virtual disk.

• Disk Size

Size of the virtual disk, in MB.

• Password


• Username


• Server

Vcenter/esx server name. It can be the IP address or name of the Vcenter/esx server where the host is located.

• Vmname


Advanced

• SCSI Controller Name ( String )

The name of the SCSI controller. If this name is null, the first SCSI controller is used.



• Disk Mode ( VMDiskMode )

Available disk modes.




Port number.

Output Values None



VM - Change VM Memory Size

This action changes the memory size of a specified Virtual Machine.

Input Values

Mandatory

• Password


• Username


• Server


• New Memory Size

Memory size of the virtual machine in MB. The memory size is rounded down to 4 MB and is not to exceed the limit defined by the guest OS.

• Vmname


Advanced


Port number.





Output Values None



VM - Create VM With Existing Disk

This action creates a Virtual Machine with an existing disk based on the resource pool. It also registers it in the inventory tree.

Input Values

Mandatory

• Ds Name

Name of the datastore to create the Virtual Disk.

• Username


• Disk File Path

Path to the Virtual Disk (folder name and file name).

• Vmname


• Password


• Server


Advanced





• Net Name ( String )

Name of VM Network.


Port number.


Datacenter name.

• Nic Name ( String )



Name of the NIC Adapter.




Guest OS Identifier.

Output Values None



VM - Destroy VM

This action destroys a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Username


• Password


• Server

The Vcenter/esx server name. It can be IP address or name of the Vcenter/esx server where the host is located.

Advanced






Port number.

Output Values None



VM - Get All Virtual Machines

This action lists all Virtual Machines in the inventory tree.

Input Values

Mandatory

• Server


• Password


• Username


Advanced


Port number.





Output Values • Vm Names ( String[] )

List of the Virtual Machine names.



VM - Get All VM Controllers

This action lists all Virtual Controllers of a specified VM.

Input Values

Mandatory

• Server

The Vcenter/esx server name. It can be IP address or name of the Vcenter/esx server where the host is located.

• Password


• Vmname


• Username


Advanced




Port number.



Output Values • Controller Types ( String[] )

Types of virtual controllers.

• Controller Names ( String[] )

Names of virtual controllers.



VM - Get All VM Disks

This action lists all Virtual Disks of a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Username


• Password


• Server


Advanced




Port number.



Output Values • Disk Names ( String [] )

Names of virtual disks.



VM - Remove CD From VM

This action removes a specified Virtual CD from a specified Virtual Machine.

Input Values

Mandatory

• Username


• Vmname


• Server


• Device Key

Device key of the CD

• Password


Advanced




Port number.



Output Values None



VM - Remove Virtual Disk From VM

This action deletes a specified Virtual Disk from a specified Virtual Machine. The files associated with this virtual disk are also removed.

Input Values

Mandatory

• Password


• Server


• Disk Name

Name of the virtual disk.

• Username


• Vmname


Advanced

• Remove File ( Boolean )

Set to True to remove associated file from the datastore.

Port ( Integer )

Port number.





Output Values None



VM - Rename VM

This action changes the name of a specified Virtual Machine.

Input Values

Mandatory

• Vm New Name

New name of the virtual machine

• Server


• Vmname


• Username


• Password


Advanced




Port number.



Output Values None



VM - Upgrade VM

This action will upgrade a specified virtual machine’s hardware to the latest revision that is supported by the ESX host.

Input Values

Mandatory

• Username


• Server


• Vmname


• Password


Advanced

• Retries ( Integer )

Number of retries for action operation.






Port number.


An operation timeout for action in milliseconds.

Output Values None



VM - Upgrade VMware Tools

This action upgrades the VMware Tools of a specified Virtual Machine.

Input Values

Mandatory

• Password


• Server


• Vmname


• Username


Advanced






Port number.

Output Values None



Migrate Actions

VM - Migrate VM

This action migrates a Virtual Machine's execution to a specific resource pool or ESX Host.

Input Values

Mandatory

• Datacenter Name

Name of the datacenter.

• Server


• Username


• Host Name

Name of the target host system to which the virtual machine is intended to migrate.

• Password


• Vmname


Advanced



• Power State ( VmPowerStateType )

If specified, the virtual machine migrates only if its state matches the specified state.




Name of the target Resource Pool.


Port number.



• Priority ( VmMovePriorityType )

Priority of the moving operation.

Output Values None



VM - Register VM

Register the specified Virtual Machine in the inventory tree.

Input Values

Mandatory

• Username


• Vm Name

Virtual machine name..

• Server


• Datastore Name

Datastore name.

• Password


Advanced

• Datacenter Name ( String )

Datacenter name.

Protocol ( String )





Port number.


Host system name.


Resource pool name.

• Is Template ( Boolean )

Whether the virtual machine is to be marked as a virtual machine template.



Output Values None



VM - Unregister VM

This action unregisters a specified Virtual Machine from the inventory tree.

Input Values

Mandatory

• Server


• Vmname


• Password


• Username


Advanced


Port number.





Output Values None



Power Actions

VM - Get VM Power State

This action retrieves the Power State of a specified Virtual Machine.

Input Values

Mandatory

• Username


• Vmname


• Server


• Password


Advanced




Port number.



Output Values • Power State VM ( String )

Power State of the Virtual Machine.



VM - Power Off VM

This action powers off a specified Virtual Machine.

Input Values

Mandatory

• Password


• Vmname


• Username


• Server


Advanced






Port number.

Output Values None



VM - Power On VM

This action powers on a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Username


• Server


• Password


Advanced




Port number.


Whether SSL certificates used.

Output Values None



VM - Reset VM

This action resets a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Username


• Server


• Password


Advanced


Port number.





Output Values None



VM - Resume VM

This action resumes a specified Virtual Machine to active state.

Input Values

Mandatory

• Username


• Server


• Vmname


• Password


Advanced






Port number.

Output Values None



VM - Shutdown Guest

This action shuts down a guest OS of a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Server


• Password


• Username


Advanced


Port number.



• Retries ( Integer )

Number of retries for action operation.




An operation timeout for action in milliseconds.

Output Values None



VM - Suspend VM

This action suspends the execution of a specified Virtual Machine.

Input Values

Mandatory

• Password


• Server


• Username


• Vmname


Advanced






Port number.

Output Values None



Snapshot Actions

VM - Create Snapshot

This action creates a new Snapshot of a specified Virtual Machine.

Input Values

Mandatory

• Username


• Server


• Snapshot Name

Name of a new snapshot.

• Password


• Vmname


Advanced






Port number.


Description of a new snapshot.

Output Values None



VM - Get Current Snapshot Name

This action retrieves the current snapshot name of a specified Virtual Machine.

Input Values

Mandatory

• Password


• Server


• Username


• Vmname


Advanced






Port number.

Output Values • Snapshot Name ( String )

Name of the current snapshot.



VM - List Snapshots

This action lists all available Snapshots of a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Password


• Username


• Server

Vcenter/esx server name. It can be IP address or name of the Vcenter/esx server where the host is located

Advanced


Port number.





Output Values • Snapshot Names ( String[] )

List of snapshot names.



VM - Remove All Snapshots

This action removes all Snapshots of a specified Virtual Machine.

Input Values

Mandatory

• Vmname


• Server


• Password


• Username


Advanced


Port number.





Output Values None



VM - Remove Snapshot

This action deletes a specified Snapshot of a specified Virtual Machine.

Input Values

Mandatory

• Password


• Server


• Vmname


• Snapshot Name

• Full path or name of the snapshot.

• Username


Advanced

• Remove Children ( Boolean )

Set to True to remove all children.


Port number.





Output Values None



VM - Rename Snapshot

This action updates the snapshot with a new name, a description or both.

Input Values

Mandatory

• Password


• Vmname


• Snapshot Name

Name of the specified snapshot.

• Username


• Server


Advanced


Port number.



Description ( String )

New description of the snapshot.



• New Name ( String )

New name of the snapshot.

Output Values None



VM - Revert To Snapshot

This action will restore a specified virtual machine to the state as it was when the snapshot was taken.

Input Values

Mandatory

• Username


• Vmname


• Password


• Server


• Snapshot Name

Name of the snapshot.

Advanced




Port number.



Output Values None


Chapter 26

Web Actions

In This Chapter

IIS Actions ..................................................................................................................................................... 573 IIS7 Actions ................................................................................................................................................... 627 URL Action .................................................................................................................................................... 646 Find Text in HTML ......................................................................................................................................... 648 REST Operation ............................................................................................................................................ 650 SOAP Request .............................................................................................................................................. 652

IIS Actions

IIS - Add ISAPI Filter This action adds an IIS ISAPI filter to a given Web site.

Input Values

Mandatory

• Filter Name ( String )

Name of the ISAPI filter.

• Filter Path ( String )

Path to the ISAPI filter.

• Filter Enabled ( Boolean )

Whether the ISAPI filter is enabled.


Name of the Web site.

Advanced

• Filter Desc ( String )

ISAPI filter description.

Output Values None

Chapter 26 Web Actions


IIS Actions


IIS - Add ISAPI WEB Service Extension Files This action configures new ISAPI WEB Service extension files in IIS.

Input Values

Mandatory

• Allow ( Boolean )

Allow/prohibit status of the extension after creation.

• Extension Files ( String )

',' comma delimited list of extension files.

• Extension Name ( String )

Name of the ISAPI WEB service extension.

Output Values None



IIS - Check Application Pool State This action checks the state of an application pool in IIS.

Input Values

Mandatory

• Expected State

Expected state.

• Application Pool

Name of the application pool.

Advanced

• Fail If Not In Expected State ( Boolean )

Set to True if you wish action to fail if application pool is not as expected; otherwise, set to False.

Output Values None

IIS Actions


IIS - Configure IP Access Restrictions to a Virtual Directory This action configures the IP addresses and domains by which access to the virtual directory is granted or denied.

All other IP addresses are vice versa denied or granted access. The grantByDefault flag determines the access rights of the IPs that are configured and those that are not.

Input Values

Mandatory

• Grant by Default

Enable grant by default.


Virtual directory name to be configured.



Advanced

• Single Computers ( String )

Comma-delimited (',') list of single computer IP addresses.

• Groups Of Computers ( String )

List composed of 2-tuples designating the IP address-subnet mask assigned to groups of computers. The 2-tuples for the listed groups are delimited by commas. For example, the following list specifies two computer groups:

10.10.10.0-255.255.255.0, 192.168.0.0-255.255.0.0

• Domains ( String )

Comma-delimited (',') list of domains.

Output Values None



IIS - Configure IP Access Restrictions to a Web Site This action configures the IP addresses and domains by which access to the virtual directory is granted or denied.

All other IP addresses are vice versa denied or granted access. The Grant By Default flag determines the access rights of the IPs configured and those that are not.

Input Values

Mandatory

• Grant By Default ( String )

Enable grant by default.



Advanced

• Domains ( String )

Comma-delimited (',') list of domains.

• Single Computers ( String )

Comma-delimited (',') list of single computer IP addresses.

• Groups Of Computers ( String )

List composed of 2-tuples designating the IP address-subnet mask assigned to groups of computers. The 2-tuples for the listed groups are delimited by commas. For example, the following list specifies two computer groups:

10.10.10.0-255.255.255.0, 192.168.0.0-255.255.0.0

Output Values None

IIS Actions


IIS - Create a Web Site This action configures a new Web site on IIS.

Input Values

Mandatory

• Home Directory ( String )

Web site home directory.

• TCP Port ( int )

Web site TCP port.



Advanced

• Custom Header ( String )

Custom headers that are sent to the client, in addition to the default header of the HTML file.

• Host Header ( String )

Host header for this site in case more than one site is configured on a single IP.

Output Values None



IIS - Create an Application Pool IIS 6.0/7.0 running in worker process isolation mode enables grouping Web applications into application pools.

Application pools allow specific configuration settings to be applied to groups of applications, and the worker processes servicing those applications. Any Web directory or virtual directory can be assigned to an application pool.

By creating new application pools and assigning Web sites and applications to them, you can make your server more efficient and reliable, and make your other applications always available, even when the applications in the new application pool terminate.

Input Values

Mandatory


Name of the application pool to be created.

Output Values None

IIS Actions


IIS - Create Virtual Directory This action configures a new virtual directory on IIS.

The virtual directory can be created either directly under a Web site or under an existing virtual directory.

Input Values

Mandatory

• Physical Directory Name ( String )

Virtual directory physical directory.





Advanced

• Application Pool ID ( String )

Virtual directory access scripts setting.

• Access Script ( Boolean )

Virtual directory access scripts setting.

Output Values None



IIS - Define Logging Schedule This action specifies how log files are created and saved.

Input Values

Mandatory

• Log Schedule

Define the scheduling for log file creation.

• Site Name


Advanced

• Log File Size ( int )

Define the maximum file size (in MB). Only relevant if use 'WHEN_FILE_REACH'.

• Log File Directory ( String )

Directory in which log files will be saved.

Output Values None

IIS Actions


IIS - Define ODBC Logging Schedule This action specifies the ODBC logging options.

Note: This action only works on Web sites (and not directories).

Input Values

Mandatory

• Password

Password associated with the user name specified previously.

• Table Name

Name of the table in the ODBC Data Source specified previously.

• Site Name


• Data Source

Name of the data source to which to connect.

• User Name

Alias of the user permitted to access this data source and table.

Output Values None



IIS - Edit Allow/Prohibit Status of an ISAPI WEB Service Extension This action sets the Allow or Prohibit status of an IIS WEB service extension.

Input Values

Mandatory


Name of the ISAPI WEB service extension.


Allow/Prohibit status of the extension after creation.

Output Values None

IIS Actions


IIS - Edit Allow/Prohibit Status of One or More ISAPI WEB Service Extension Files This action sets the Allow or Prohibit status of one or more IIS WEB service extension files.

Input Values

Mandatory


Allow/Prohibit status of the extension files.


Comma-delimited (',') list of extension files.

Output Values None



IIS - Edit Authentication Methods on a Virtual Directory This action configures the authentication methods of a virtual directory on IIS. You can authenticate individuals or select groups of users to prevent unauthorized persons from establishing a Web (HTTP) connection to restricted content. Anonymous access allows users to establish an anonymous connection. The user logs on to IIS with an anonymous or guest account.

Input Values

Mandatory

• Site Name

Name of the web site which the targeted virtual directory resides on.

• Anonymous Access

Enable anonymous access.

• Anonymous Password Sync

Enables/disables anonymous user password synchronization in IIS 5.x. and higher. If True, IIS defines the password.

• Basic Auth

Enable basic -clear text password- authentication.

• Integrated Windows Auth

Enable integrated windows authentication.

• Windows Domain Servers Digest Auth

Enable digest authentication for windows servers.

• Virtual Directory Name


Advanced

• Anonymous User ( String )

Anonymous user ID.


Domain or other operating system authentication controller used to authenticate the user or group. Applicable when digest and/or basic authentication modes are enabled.

• Default Domain ( String )

Windows domain used for user authentication control. Applicable if basic authentication or .NET authentication is enabled.

IIS Actions


• Anonymous Password ( Password )

Anonymous user password.

Output Values



IIS - Edit Authentication Methods on a Web Site This action configures the authentication methods of a virtual directory on IIS. You can authenticate individuals or select groups of users to prevent unauthorized persons from establishing a Web (HTTP) connection to restricted content. Anonymous access allows users to establish an anonymous connection. The user logs on to IIS with an anonymous or guest account.

There are currently four Authenticated access methods:

• Windows Integrated authentication uses a cryptographic exchange with the user's Web browser to confirm the identity of the user.

• Digest authentication works only with Active Directory accounts, sending a hash value over the network, rather than a plaintext password. Digest authentication works across proxy servers and other firewalls and is available on Web Distributed Authoring and Versioning (WebDAV) directories.

• Basic authentication transmits passwords across the network in cleartext, an unencrypted form.

• .NET Passport authentication is a Web authentication service.

Input Values

Mandatory

• Site Name

Name of the web site which the targeted virtual directory resides on.

• Basic Auth

Enable basic -clear text password- authentication.

• Anonymous Access

Enable anonymous access.

• Integrated Windows Auth

Enable integrated windows authentication.

• Windows Domain Servers Digest Auth

Enable digest authentication for windows servers.

• Anonymous Password Sync

Enables/disables anonymous user password synchronization in IIS 5.x. and higher. If True, IIS defines the password.

Advanced


Domain or other operating system authentication controller used to authenticate the user or group. Applicable when digest and/or basic authentication modes are enabled.

IIS Actions


• Anonymous User ( String )

Anonymous user ID.

Default Domain ( String )

Windows domain used for user authentication control. Applicable if basic authentication or .NET authentication is enabled.

• Anonymous Password ( Password)

Anonymous user password.

Output Values None



IIS - Edit ISAPI Filter This action edits an IIS ISAPI filter for a given Web site.

Input Values

Mandatory

• Filter Path

ISAPI filter path.

• Filter Name

ISAPI filter name.

• Site Name


Advanced

• Filter Enabled ( Boolean )

Whether the created filter is enabled.

• Filter Desc ( String )

ISAPI filter description.

Output Values None

IIS Actions


IIS - Issue and Assign Server Certificate This action issues a SSL server certificate for an IIS Web site from Certificate Authority (CA), and stores the issued certificate on the target local machine's certificate store, and assigns it to a Web site.

This action assumes that CA is configured to issue certificates automatically. If CA's policy is to manually approve each certificate request then this action will fail.

It is also assumed that CA's service is running and operational. If CA's service is not operational then an access denied response will be returned.

Input Values

Mandatory

• Web Site Name ( String )

Name of the Web site to be assigned the certificate.

Advanced

• Certificate Authority Name ( String )

Certificate authority service name.

• Certificate Authority Host Name ( String )

Certificate authority's server host name.

• Certificate Common Name ( String )

Certificate Common Name (CN). For a secure connection to be successfully established, the CN must match the intranet/DNS name of the machine on which the Web site is hosted.

Output Values None



IIS - Modify Application Pool - 'Health' Tab This action modifies the Health tab in a given application pool.

Input Values

Mandatory

• Application Pool ( String )


Advanced

• Startup Time Limit ( Integer )

Set the worker process startup time, in seconds, program terminations.

• Enable Rapid Fail ( Boolean )

Select to configure IIS to remove this application pool from service and place it in a mode where the kernel-mode driver immediately returns a 503 Service Unavailable - out-of-service message to any requests to that application pool.

If this value is set to True, then Failures and Time Period must have values.

• Failures ( Integer )

Set a numerical limit on unexpected program terminations.

• Time Period ( Integer )

Set a time limit in which to detect the corresponding number of unexpected program terminations.

• Shutup Time Limit ( Integer )

Worker process termination time, in seconds, after IIS detects inactivity.

• Enable Pinging ( Boolean )

Select to configure Internet Information Services (IIS) to ping each worker process in an application pool every specified number of seconds to detect the activity of the processes.

If this value is set to True, then Ping Worker Process must have a value.

• Ping Worker Process ( Integer )

Enter a number to set the time interval, in seconds, when worker processes are pinged for activity.

Output Values None

IIS Actions


IIS - Modify Application Pool - 'Identity' Tab This action modifies the Identity tab in a given application pool.

Input Values

Mandatory



Advanced


User name of the user permitted to access this data source and table.

• Predefined ( PredefinedIdentity )

Select predefined security accounts in the list box. If a Specified User is selected, the User Name and User Password must have values.

• User Password ( String )

Password that is associated with the user name specified in User Name.

Output Values None



IIS - Modify Application Pool - 'Performance' Tab This action modifies the Performance tab in a given application pool.

Input Values

Mandatory



Advanced

• Enable Cpu Monitoring ( Boolean )

Select to configure IIS to use CPU accounting to track and terminate worker processes that consume large amounts of CPU time that exceed the specified limits.

If this value is set to True, then Max CPU Use, Refresh CPU Usages, and Action Performed must have values.

• Request Queue Limit ( Integer )

Shut down worker processes after being idle for this length of time, in minutes.

To disable this option, write 65535.

• Action Performed ( ActionPerformed )

Action performed when CPU usage exceeds maximum CPU use - select the best action to perform when the CPU exceeds its specified maximum usage:

1. If No action is selected, when the CPU usage for a specific application pool or group of pools reaches the set limit, IIS writes an error in the Event Log.

2. If Shutdown is selected, when the CPU usage for a specific application pool reaches the set limit, IIS initiates a shutdown of all worker processes in the application pool by allowing each worker process to shut down in the application pool's specified ShutdownTimeLimit in seconds.. If the processes do not shut down in this time frame, IIS terminates the worker processes. The application pool shuts down and resets according to the time limit set in CPUResetInterval.

• Max Cpu Use ( Integer )

Set the maximum percentage of CPU (number between 0-100) that a worker process is allowed to use.

• Refresh Cpu Usage Num ( Integer )

Time interval, in minutes, after which the CPU process numbers should be refreshed, in order to be used by CPU monitoring.

• Max Worker Processes ( Integer )

IIS Actions


Maximum number of worker processes allowed within an application pool.

• Idle Timeout ( Integer )

Maximum amount of time, in minutes, that worker processes can remain idle, after which they are shut down.

To disable this option, set this value to 0.

Output Values None



IIS - Modify Application Pool - 'Recycling' Tab This action modifies the Recycling tab in a given application pool.

Input Values

Mandatory



Advanced

• Maximum Virtual Memory ( Integer )

Maximum amount of your system's common virtual memory (in MB) that can be used by a worker process before the process is recycled.


• Maximum Used Memory ( Integer )

Maximum amount of privately allocated system physical memory (in MB) that can be used by a worker process before the process is recycled.


• Add Or Remove Schedule ( AddOrRemove )

Whether to add or to remove a recycle worker processes schedule. The scheduling time is defined in the Recycle Worker Processes Schedule.

• Recycle Workerprocesses Number Of Requests ( Integer )

Number of requests after which worker processes should be recycled.


• Recycle Workerprocesses Schedule ( String )

Recycle Worker processes at the following time. Select to recycle worker processes after a specific number of requests. Write '0' to disable the option.

• Recycle Workerprocessesin Minutes ( Integer )

Number of minutes of inactivity after which worker processes should be recycled.


Output Values None

IIS Actions


IIS - Modify File or Directory - HTTP Headers Tab This action modifies the HTTP Headers tab on a given Web site.

Input Values

Mandatory


Defines the path to the file/directory within the Web site (e.g. if a directory with the name 'myDir' resides under the directory 'rootDir', write 'rootDir/myDir'.

• Is file ( String )

Define whether the IIS file or the IIS directory needs to be modified. Set to True for file, False for directory.



Advanced

• Add Remove Header

Select 'Add' to add/edit the HTTP header or 'Remove' to remove it. The header itself should be defined in Custom Http Header.

• Custom Http Header ( )

HTTP header to add/remove/edit. The HTTP header must be in the format of "Key:Value", otherwise the action will fail.

• Content Expiration ( )

Enable content expiration to include the expiration information for time-sensitive material, such as special offers or event announcements.

1. Write "-1" to disable the feature.

2. Write "0" to expire immediately after content is served.

3. Write the time in seconds (e.g. use "600" for 10 minutes.)

4. Write a valid GMT date "Fri, 24 Oct 2008 22:00:00" - make sure it is in a GMT time zone format.

Output Values None



IIS - Modify Virtual Dir Path This action modifies the virtual directory path.

Input Values

Mandatory

• Iis Script Directory ( String )

IIS Script working directory.

• New Full Path ( String )

New full path of the virtual directory.

• Virtual Directory Full Path ( String )

Current full path of the virtual directory.

Output Values


Return value of the finished process. Long parameter can be used with this output.

IIS Actions


IIS - Modify Directory or Virtual Directory - 'Custom Errors' Tab This action modifies the Custom Errors tab on a given virtual directory.

Input Values

Mandatory


Name of the virtual directory name to be configured.



Advanced

• Content Type ( HttpContentType )

Content's source, which is defined in the Contents input (below). One of:

File - Full path to an html file.

URL - URL to a local file only (in the form of '/filename.htm').

Default - Default message for the source code will appear.

• Contents ( String )

File name or URL for the source code. It must be in the form "Key,Value" otherwise the action will fail.

• Http Error ( String )

HTTP error code, such as 400 or 500. A sub-error code should be written like this: 400,1.

Output Values None



IIS - Modify Directory or Virtual Directory - 'Documents' Tab This action modifies the Documents tab on a given virtual directory.

Input Values

Mandatory





Advanced

• Content Page ( String )

Default document to add/remove, depending on the value of Add Remove Page.

• Add Remove Page ( AddOrRemove )

Whether to add or remove the content page written in the Content Page input. The action will be failed if the file was not found.

• Enable Default Content Page ( Boolean )

If True, the default document is served to the browser whenever the browser request does not specify a document name.

• Enable Document Footer ( Boolean )

If True, the Web server will be configured to automatically append a footer to every document that the Web server returns. The file is listed in the Footer File (below).

• Fail If Not Exist ( String )

If True, the action will fail if trying to remove content file that does not exist.

• Footer File ( String )

If True, it will configure your web server to automatically append a footer to every document your web server returns. The file is listed in the Footer File input.

Output Values None

IIS Actions


IIS - Modify Directory or Virtual Directory - 'HTTP Headers' Tab This action modifies the HTTP Headers tab on a given Web site.

Input Values

Mandatory





Advanced

• Add Remove Header ( AddOrRemove )

Specify one of the following:

Add - To add/edit the HTTP header.

Remove - To remove the HTTP header.

The header itself should be defined in the Custom Http Header input.

• Content Expiration ( String )

Enables content expiration to include expiration information for time-sensitive material, such as special offers or event announcements. Use one of the following methods:

Write -1 to disable the feature.

Write 0 for the content to expire immediately after it is served.

Write the time duration in seconds (for example, write 600 for 10 minutes).

Write a valid GMT date and time (e.g. Fri, 24 Oct 2008 22:00:00). Make sure that it is in a GMT time zone.

• Custom Http Header ( String )

HTTP header to be added, edited, or removed. It must be in the form of "Key:Value", otherwise the action will fail.

Output Values None



IIS - Modify Directory or Virtual Directory - 'Virtual Directory' Tab This action modifies the Virtual Directory tab on a given Web site.

Input Values

Mandatory





Advanced

• Write ( Boolean )

True indicates that users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a write-enabled file.

• Exact Url ( Boolean )

Select to redirect a virtual directory to the destination URL without adding any other portions of the original URL.

• Index This Resource ( Boolean )

Whether the installed content indexer should index content under this directory tree.

• Allow Server Debug ( Boolean )

Whether to enable the Web server to invoke the Microsoft Script Debugger while processing ASP pages.

• Read ( Boolean )

True indicates that the file or the contents of the folder may be read.

• ASP Script Timeout ( Integer )

Primary script language for Active Server Pages, the language used to process commands within ASP delimiters ().

• Script Source Access Flag ( Boolean )

True indicates that users are allowed to access source code if either Read or Write permissions are set.

• Visit Logs ( Boolean )

Whether client requests are written to the IIS log files.

IIS Actions



Name of the root directory that contains the files and subdirectories of an application.

• Directory Browsing ( Boolean )

Enable directory browsing.

• Permanent ( Boolean )

Click to send the following message to the client: "301 Permanent Redirect."

• Local Path Or Url ( String )

Specify the Local Path/Network Directory/URL for this resource, (it depends on Content Resource).

• Content Source ( ContentSource )

From where the content for this resource should come.


Encrypted password used to gain access to the Universal Naming Convention (UNC) virtual roots. If not needed, leave this and the User Name inputs empty.

• Allow Client Debug ( Boolean )

Whether to enable the client to invoke the Microsoft Script Debugger while processing ASP pages.

• Manifest File Name ( String )

COM+ manifest file name. To disable side-by-side assemblies, type a value of -1.

• Cache ISAPI ( Boolean )

Cache ISAPI property indicates whether ISAPI extensions are cached in memory after first use.

If the value of this property is set to True, ISAPI extensions, once loaded, remain in the cache until the server is stopped.

If the value is set to False, extensions are unloaded from memory after the ISAPI extension is no longer in use.

ISAPI extensions are cached or not cached based on the value of this property at the time they were loaded into memory for use. Thus, if this property is changed after an extension has been loaded and cached, the change will have no effect on that extension until the web server is restarted.

• Add Script Map ( Boolean )

Whether to add (if set to True) or remove (if set to False) the strings in the scriptMaps.

• Session Timeout ( Integer )

Timeout period for all inactive sessions on this system. To disable timeout, use a value of -1.

• Child Only ( Boolean )

Select to redirect a parent directory to a child directory.



• Execute Permission ( ExecutePermission )

Program execution level allowed for this site's resources. One of the following values:

None - Access restricted to static files, such as HTML or image files.

Scripts - Only scripts are allowed to run, but not executables.

Scripts and Executables - All restrictions are removed, so that all file types can be accessed or executed.

• Default ASP Language ( String )

Primary script language for the Active Server Pages. The primary script language used to process commands within the ASP delimiters ().

• Script Maps ( String[] )

Script Maps property specifies the file name extensions of applications used for script processor mappings.

The list string is written in the following format: 'Extension, ScriptProcessor, Flags, IncludedVerbs'.

Where Extension is the file name extension, such as .htm, ScriptProcessor is the full path to the DLL, Flags is the integer value corresponding to the requested behavior described in the Bitmask Table, and IncludedVerbs is a list of the verbs that a particular ISAPI DLL processes.

For example, to specify the file extension for the ISAPI "Test.dll" with a file extension of ".htm", you might provide the following list ( String ):

".htm,C:\Windows40\System32\Inetsrv\Test.dll,5,GET, HEAD, POST"


Application pool that is associated with this home directory.Script Source Access Flag ( Boolean )

True indicates that users are allowed to access source code if either Read or Write permissions are set.

• Enable Buffering ( Boolean )

Whether IIS may allow all output that is generated by an ASP page to be collected before it is sent to the browser.


User name for the Universal Naming Convention (UNC) virtual roots. If not needed, leave this and the User Password inputs empty.

• Enable Parent Path ( Boolean )

Whether to allow ASP pages to use relative paths to the parent directory of the current directory. (Relative paths use the .. syntax.)


IIS Actions


Default error message to the browser when an error prevents the Web server from processing the ASP page. Type (-1) to remove the existing message and stop sending it.

Output Values None



IIS - Modify Web Site - 'Custom Errors' Tab This action modifies the Custom Errors tab on a given Web site.

Input Values

Mandatory



Advanced

• Contents ( String )

File name or URL for the source code. It must be in the form "Key,Value" otherwise the action will fail.

• Content Type ( HttpContentType )

Content's source, which is defined in the Contents input (below). One of:

File - Full path to an html file.

URL - URL to a local file only (in the form of '/filename.htm').

Default - Default message for the source code will appear.

• Http Error ( String )

HTTP error code, such as 400 or 500. A sub-error code should be written like this: 400,1.

Output Values None

IIS Actions


IIS - Modify Web Site - 'Documents' Tab This action modifies the Documents tab on a given virtual directory.

Input Values

Mandatory



Advanced

• Content Page ( String )

Default document to add or remove, depending on the value of Add Remove Page value.

• Enable Default Content Page ( Boolean )

If True, the default document is served to the browser whenever the browser request does not specify a document name.

• Enable Document Footer ( Boolean )

If True, the Web server will be configured to automatically append a footer to every document that the Web server returns. The file is listed in the Footer File input (below).

• Add Remove Page ( AddOrRemove )

Whether to add or to remove the content page written in the Content Page input. If the file specified in Content Page is not found, the action will fail.

• Footer File ( String )

If True, it will configure your Web server to automatically append a footer to every document your web server returns. The file is listed in the Footer File input.

• Fail If Not Exist ( String )

If True, the action will fail if trying to remove content file that does not exist.

Output Values None



IIS - Modify Web Site - 'Home Directory' Tab This action modifies the Virtual Directory tab on a given Web site.

Input Values

Mandatory



Advanced

• Script Maps ( String[] )

Script Maps property specifies the file name extensions of applications used for script processor mappings.

The list string is written in the following format: 'Extension, ScriptProcessor, Flags, IncludedVerbs'.

Where Extension is the file name extension, such as .htm, ScriptProcessor is the full path to the DLL, Flags is the integer value corresponding to the requested behavior described in the Bitmask Table, and IncludedVerbs is a list of the verbs that a particular ISAPI DLL processes.

For example, to specify the file extension for the ISAPI "Test.dll" with a file extension of ".htm", you might provide the following list ( String ):

".htm,C:\Windows40\System32\Inetsrv\Test.dll,5,GET, HEAD, POST"


Application pool that is associated with this home directory.


Encrypted password used to gain access to the Universal Naming Convention (UNC) virtual roots. If not needed, leave this and the User Name inputs empty.

• Execute Permission ( ExecutePermission )

Program execution level allowed for this site's resources. One of the following values:

None - Access restricted to static files, such as HTML or image files.

Scripts - Only scripts are allowed to run, but not executables.

Scripts and Executables - All restrictions are removed, so that all file types can be accessed or executed.


Whether to redirect a parent directory to a child directory.


IIS Actions


Whether to send the following message to the client: 301 Permanent Redirect.

• Directory Browsing ( Boolean )

Whether directory browsing is enabled.

• Cache ISAPI ( Boolean )

Cache ISAPI property indicates whether ISAPI extensions are cached in memory after first use.

If the value of this property is set to True, ISAPI extensions, once loaded, remain in the cache until the server is stopped.

If the value is set to False, extensions are unloaded from memory after the ISAPI extension is no longer in use.

ISAPI extensions are cached or not cached based on the value of this property at the time they were loaded into memory for use. Thus, if this property is changed after an extension has been loaded and cached, the change will have no effect on that extension until the web server is restarted.


Default error message to the browser when an error prevents the Web server from processing the ASP page. Type (-1) to remove existed message and stop sending it.



• Session Timeout ( Integer )

Timeout period for all inactive sessions on this system. To disable timeout, use a value of -1.

• Allow Server Debug ( Boolean )

Whether to enable the Web server to invoke the Microsoft Script Debugger while processing ASP pages.

• Manifest File Name ( String )

COM+ manifest file name. To disable side-by-side assemblies, type a value of -1.


True indicates that users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file.

• Allow Client Debug ( Boolean )

Whether to enable the client to invoke the Microsoft Script Debugger while processing ASP pages.

• Exact Url ( Boolean )

Whether to redirect a virtual directory to the destination URL without adding any other portions of the original URL.




If True, users are allowed to access source code if either the Read or Write permissions (see below) are set.

• Enable Parent Path ( Boolean )

Whether to allow ASP pages to use relative paths to the parent directory of the current directory. (Relative paths use the .. syntax.)

• Index This Resource ( Boolean )

Whether the installed content indexer should index content under this directory tree.

• Local Path Or Url ( String )

Local Path/Network Directory/URL for this resource (depends on the content resource).

• ASP Script Timeout ( Integer )

Primary script language for Active Server Pages, the language used to process commands within ASP delimiters ().


User name for the Universal Naming Convention (UNC) virtual roots. If not needed, leave this and the User Password inputs empty.


Source from where the content for this resource should come.

• Default ASP Language ( String )

Primary script language for the Active Server Pages. The primary script language used to process commands within the ASP delimiters ().


Name of the root directory that contains the files and subdirectories of an application.

• Add Script Name ( Boolean )

Whether to add (if set to True) or remove (if set to False) the strings in the scriptMaps.

• Enable Buffering ( Boolean )

Whether IIS may allow all output that is generated by an ASP page to be collected before it is sent to the browser.


True indicates that the file or the contents of the folder may be read.

Output Values None

IIS Actions


IIS - Modify Web Site - 'HTTP Headers' Tab This action modifies the HTTP Headers tab on a given Web site.

Input Values

Mandatory



Advanced

• Content Expiration ( String )

Enables content expiration to include expiration information for time-sensitive material, such as special offers or event announcements. Use one of the following methods:

Write -1 to disable the feature.

Write 0 for the content to expire immediately after it is served.

Write the time duration in seconds (for example, write 600 for 10 minutes).

Write a valid GMT date and time (for example, Fri, 24 Oct 2008 22:00:00). Make sure that it is in a GMT time zone format.

• Add Remove Header ( AddOrRemove )

Specify one of the following:

Add - To add/edit the HTTP header.

Remove - To remove the HTTP header.

The header itself should be defined in the Custom HTTP Header input.

• Custom Http Header ( String )

HTTP header to be added, edited, or removed. It must be in the form of "Key:Value", otherwise the action will fail.

Output Values None



IIS - Modify Web Site - 'Performance' Tab This action modifies the Performance tab on a given Web site.

Input Values

Mandatory



Advanced

• Max Connections ( Integer )

Maximum number of simultaneous connections to the Web site. For an unlimited number, use a value of -1.

• Max Bandwidth ( Integer )

Maximum network bandwidth, in KB per second, used for the Web site. For an unlimited bandwidth, use a value of -1.

Output Values None

IIS Actions


IIS - Modify Web Site - 'Web Site' Tab This action modifies the Web Site tab on a given Web site.

Input Values

Mandatory



Advanced

• Enable Logging ( Boolean )


• Tcp Port ( Integer )

Web site's TCP port.

• SSL Port ( Integer )


• Allow Keep Alive ( Boolean )

Whether Keep-Alive processing is permitted.

• Additional IP Address ( String[] )

Additional IP addresses to be used for accessing this site. They should be in the form: IPAddress:Port, e.g. 192.168.0.100:800.

• Connection Time Out ( Integer )

Time in seconds that IIS waits before it disconnects a connection.

• Add IP Address ( Boolean )

If set to True, the bindings in additional IPAddress will be added; if set to False, they will be removed

• Host Header ( String )

Host header for this site in case more than one site is configured on a single IP.


IP address to use for accessing the Web site.

Output Values None



IIS - Modify Web Site - ASP.NET Version This action sets the ASP.NET version for a Web site.

Input Values

Mandatory

• Full Path To Asp Net Installation ( String )

Full path to the ASP.NET installation dir, for example: c:\WINDOWS\Microsoft.NET\Framework\v1.1.4322.



Advanced

• Virtual Dir Name ( String )

Name of the virtual directory, leave blank for root Web site.

Output Values None

IIS Actions


IIS - Modify Web Site - File-File Tab This action modifies the 'File' tab on a given File in a specific IIS Web site.

Input Values

Mandatory

• Site Name


• File Name

Name of the file name. should contain its path in the site (for example: dirName/fileName.html).

Advanced


Content for this resource should come from.


Value of true indicates that the file or the contents of the folder may be read.


Select to redirect a parent directory to a child directory.


Value of true indicates that users are allowed to access source code if either Read or Write permissions are set.


Click to send the following message to the client: "301 Permanent Redirect."


Value of true indicates that users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a write-enabled file.

• Url ( String )

URL redirection address. Relevant only if contentSource is URL.



Output Values None



IIS - Modify Web Site - Logging Properties This action customizes Extended logging by choosing the fields (items) to be recorded in the log.

Input Values • Site Name


Advanced

• Log total bytes sent ( Boolean )

Log the total bytes sent.

• Log HTTP status ( Boolean )

Log the HTTP status.

• Log the active server port ( Boolean )

Log the active server port.

• Log contents of the user agent field ( Boolean )

Log the contents of the user agent field sent by the client.

• Log total bytes received ( Boolean )

Log the total bytes received.

• Log URI ( Boolean )

Log the Universal Resource Identifier (URI) stem information. The URI stem usually consists of the actual resource being requested.

• Log URI parameters ( Boolean )

Log the Universal Resource Identifier (URI) query information. The URI query usually consists of parameters passed to the URL by using the URL Parameters format.

• Log local computer name ( Boolean )

Log the local computer name.

• Log host ( Boolean )

Log the name of host server.

• Log the server's own IP address ( Boolean )

Log the server's own IP address.

• Log Site ( Boolean )

Log the site name.

IIS Actions


• Log the sub-status code of the HTTP error ( Boolean )

Log the sub-status code of the HTTP error. For example, for the 500.18 HTTP error, the status code is 500 and the sub-status code is 18.

• Log IP ( Boolean )

Log the client IP address.

• Log User Name ( Boolean )

Log the username.

• Log protocol method ( Boolean )

Log the protocol method.

• Log the time ( Boolean )

Log the time.

• Log Microsoft Win32 error status ( Boolean )

Log the current Microsoft Win32 error status.

• Log the client server protocol version ( Boolean )

Log the client server protocol version.

• Log total time for request to be completed ( Boolean )

Log total time for a request to be completed.

• Log the date ( Boolean )

Log the date.

• Log information from the client cookie ( Boolean )

Log information from the client cookie.

• Log the referrer field sent by the client ( Boolean )

Log the referrer field sent by the client.

Output Values None



IIS - Perform Operation on an Application Pool This action performs start, stop or recycle on application pool in IIS.

Input Values

Mandatory

• Application Pool

Name of the Application Pool.

• Operation

Select the operation to perform on the application pool.

Output Values

None

IIS Actions


IIS - Prohibit All ISAPI WEB Service Extensions Disables all IIS WEB service extensions by setting their status to prohibited.

Input Values None

Output Values None



IIS - Remove a Virtual Directory This action removes an IIS virtual directory.

Input Values

Mandatory



• Site Name


Output Values None

IIS Actions


IIS - Remove a Web Site This action removes a Web site from IIS.

Input Values

Mandatory


Name of the Web site to be removed from IIS.

Output Values None



IIS - Remove an ISAPI Filter This action removes an IIS ISAPI filter from a given Web site.

Input Values

Mandatory



• Filter Name ( String )

Name of the ISAPI filter.

Output Values None

IIS Actions


IIS - Remove an ISAPI WEB Service Extension This action removes an existing WEB service extension and all of its associated files from IIS.

Input Values

Mandatory


Name of the ISAPI WEB service extension to be removed from IIS.

Output Values None



IIS - Remove ISAPI WEB Service Extension Files This action removes the specified ISAPI WEB service extension files from IIS.

Input Values

Mandatory


Comma-delimited list of extension files to be removed from IIS.

Output Values None

IIS Actions


IIS - Toggle SSL on a Virtual Directory This action configures IIS to require an encrypted communication link for a Web browser to connect with this directory.

When this option is selected, all data sent to and from this Web virtual directory is encrypted using a certificate.

Input Values

Mandatory


Boolean field which configures IIS to require a 128-bit encrypted communication link for a web browser to connect with this Web site, directory, or file.


Name of the virtual directory to be configured opposite IIS.




Boolean field which configures IIS to require an encrypted communication link for a web browser to connect with this Web site, directory, or file. When this option is selected, all data sent to and from this Web site is encrypted using a certificate.

Output Values None



IIS - Toggle SSL on a Website This action configures IIS to require an encrypted communication link for a Web browser to connect with this Website.

When this option is selected, all data sent to and from this Website is encrypted using a certificate.

Input Values

Mandatory


Web site name.


Boolean field which configures IIS to require a 128-bit encrypted communication link for a Web browser to connect with this Website, directory, or file.


Boolean field which configures IIS to require an encrypted communication link for a Web browser to connect with this Website, directory, or file. When this option is selected, all data sent to and from this Website is encrypted using a certificate.

Output Values None

IIS7 Actions


IIS7 Actions

IIS7 - Application Pool Tasks This action allows you to start, stop or recycle a selected application pool.

Input Values

Mandatory

• Application Pool Name

Application pool name.

• Action

Action to perform on the application pool.

Advanced


The number of seconds to wait for the command to finish. Default is 0 (no timeout.)

Output Values • Output ( String )

Command output.



IIS7 - Assign an Application to an Application Pool This action allows you to assign an application to an application pool.

Input Values

Mandatory

• Website Name

Name of the website you wish to modify.



Advanced



• Application path ( String )

Path of the application that will run in the application pool. A blank value will be interpreted as "/" which means the root application of the site.


Command output.

IIS7 Actions


IIS7 - Change an Application Pool for an Application This action changes an application pool for a given application.

Input Values

Mandatory


Name of the application pool to which you wish to assign the application.

• Website Name

Name of the Website you wish to modify.

Advanced


Number of seconds to wait for the command to finish. Default is 0 (no timeout.)


Path of the application that will run in the application pool. Blank value will be interpreted as "/", which means the root application of the site.


Command output.



IIS7 - Check Application Pool State This action verifies the state of an application pool.

Input Values

Mandatory

• State

Expected state. Possible values: Started, Starting, Stopped, Stopping, or Unknown.



Advanced

• Fail if in state ( Boolean )

Whether the action will fail if application pool's state equals State parameter. Default value is False.

If set to True, the action will fail if application pool's state equals the expected one.

If set to False, the action will fail if application pool's state is different than expected.


Number of seconds to wait for the command to finish. Default is 0 (no timeout).

Output Values • Timed Out ( Boolean )

True if action timed out; False if action did not time out.

• Application Pool State ( String )

Actual application pool state.

• Exit Code ( Long )

Command exit code.

• Output ( String )

Command output.

IIS7 Actions


IIS7 - Check if a virtual directory exists This action checks whether a given virtual directory exists.

Input Values

Mandatory

• Website Name

Name of the website.

Advanced

• Virtual Directory Path ( String )

Path of the virtual directory on the website. The path should start with "/".






Command exit code.


Command output.



IIS7 - Check if a website exists This action checks whether a given virtual Website exists.

Input Values

Mandatory

• Website Name

Name of the Website.

Advanced

• Timeout (long)



Command output.


Command exit code.

• Timed Out ( Boolean )

True if action timed out; False action did not time out.

IIS7 Actions


IIS7 - Check if an application exists This action checks whether a given application exists.

Input Values

Mandatory

• Website Name

Name of the Website.

Advanced




Path of the application that will run in the application pool. Blank value will be interpreted as "/" which means the root application of the site.




Command output.


Command exit code.



IIS7 - Check if an application pool exists This action checks whether a given application pool exists.

Input Values

Mandatory



Advanced




Command output.

• Timed Out ( Boolean )



Command exit code.

IIS7 Actions


IIS7 - Create an Application Pool This action allows you to create a new application pool.

To add an application pool to a Web server by using default settings, fill Application pool name parameter only.

By default, IIS adds an application pool that runs in integrated managedPipelineMode and uses .NET Framework version 2.0. If you want to add an application pool that runs a different version of the .NET Framework or that uses classic managedPipelineMode, you can specify the .NET Framework version with the /managedRuntimeVersion attribute and the managed request-processing managedPipelineMode with the /managedPipelineMode attribute.

Input Values

Mandatory

• Application pool name

Name of the application pool you wish to create.

Advanced

• Managed Runtime Version ( String )

Version of the .NET Framework that you want the application pool to run. When you want to run a specific version of the .NET Framework, specify its value as v1.0, v1.1, or v2.0, or leave the value blank if you do not want to run managed code in the application pool.



• Managed Pipeline Mode ( ManagedPipelineMode )

Site name.


Command output.



IIS7 - Create a Virtual Directory This action creates a new virtual directory. A virtual directory is a directory name, used in an address, which corresponds to a physical directory on the server.

Input Values

Mandatory


Name of the virtual directory.

• Physical Path

Physical path of the virtual directory's content in the file system.

• Site Name

Site name.

Advanced


To add a virtual directory to an application other than a site's root application, enter the name of the application.




Command output.

IIS7 Actions


IIS7 - Create a Web Application This action creates a new Web application.

Input Values

Mandatory

• Path

Virtual path of the application, such as "/application".

• Website Name

Name of the Web site to which to add the application.

• Physical Path

Physical path of the application's content in the file system.

Advanced


Number of seconds to wait for the command to finish. Default is 0 (no timeout.)


Command output.



IIS7 - Create a Website This action configures a new Website.

Input Values

Mandatory

• Physical Path

Will cause the root application containing a root virtual directory pointing to the specified path to be created for this site.

• Website Name

Name of the Website to create.

• Bindings

List of bindings in the friendly form of "http://domain:port,..." or raw form of "protocol/bindingInformation,..."

Advanced




Command output.

IIS7 Actions


IIS7 - Delete an Application Pool This action allows you to delete an application pool.

Input Values

Mandatory

• Application pool name

Name of the application pool to delete.

Advanced




Command output.



IIS7 - Delete a Virtual Directory This action allows you to delete a virtual directory.

Input Values

Mandatory

• Site Name

Site name.

• Virtual Directory Path

Path of the virtual directory you wish to delete. For Example, if you wish to delete the virtual directory "vdir" under application "app" which is under your selected website, enter: "/application/vdir". An empty string is interpreted as "/".

Advanced




Command output.

IIS7 Actions


IIS7 - Delete a Website This action allows you to delete a Website.

Input Values

Mandatory

• Website Name

Name of the Website to delete.

Advanced




Command output.



IIS7 - Edit Application Pool Identity This action allows you to configure the identity of an application pool. The identity of an application pool is the name of the service account under which the application pool's worker process runs. You can configure application pools to run under one of the built-in user accounts in the operating system or under a custom account.

Input Values

Mandatory



• Identity Type

Choose between the built-in user accounts or choose "SpecificUser" to configure a custom account.

Advanced


Password for custom account.




User name for custom account.


Command output.

IIS7 Actions


IIS7 - Modify a Virtual Directory This action modifies a virtual directory.

Input Values

Mandatory

• Physical Path

Physical path of the virtual directory's content in the file system.

• Virtual Directory Path

Path of the virtual directory you wish to modify. For Example, if you wish to modify the virtual directory "vdir" under application "app" which is under your selected website, enter: "/application/vdir". An empty string is interpreted as "/".

• Site Name

Site name.

Advanced




Command output.



IIS7 - Modify Website Logging This action allows you to change the log's directory.

Input Values

Mandatory

• Site Name

Site name.

Advanced

• Enable Logging ( Boolean )

Choose True to enable logging, and False to disable logging



• Log File Rollover ( LogSchedule )

Choose how often to create a new log file. When "MaxSize" is chosen, you can fill the parameter "logMaxSize" to limit the log's size

• Log Max Size ( Integer )

Specifies the size of the log to be created based on the Log File Rollover parameter. Integer value must be between 1048576 and 4294967295.

• Directory Path ( String )

Directory path in which to save the logs.


Command output.

IIS7 Actions


IIS7 - Run Appcmd This action allows you to run a command in appcmd.exe.

Input Values

Mandatory

• Command

Command arguments you want to run in appcmd.exe. Do not enter "appcmd.exe" in the beginning. For example: "list sites /state:started".

Advanced






Command output.


Command exit code.



URL Action

Access URL This action accesses a given URL, with an optional check of the HTTP response code.

Input Values

Mandatory

• URL ( String )

HTTP URL to access.

Advanced

• Use Preemptive Authentication( Boolean )

Whether to use Preemptive Authentication when using a user name to login to the Web site.


User name for authentication. Only relevant if Authentication Method is not "NONE".

• Read Timeout ( Integer )

Time in seconds of the default socket timeout, which is the timeout for waiting for data. A timeout value of zero is interpreted as an infinite timeout.


Realm that authenticates the user. Only relevant if Authentication Method is BASIC or DIGEST.

• Expected Code ( int )

Expected HTTP return code.


Whether to use POST or GET method. Default is False for GET.


Can be set to each of the following methods: Basic, Digest or NTLM. These can be used to authenticate with HTTP servers or proxies. NONE means no authentication is required.

• Response File Path ( String )

Path to the file to save the response.


Server domain. Only relevant if Authentication Method is not NONE.

• Check Response Code ( Boolean )

URL Action


Whether actual response code should be matched against expected. If True and actual response code is not equal to expected, the action will fail.

• Connection Timeout (seconds) ( Integer )

Determines the number of seconds until a connection is established. Default value is 1 minute. A value of zero means the timeout is not used.


User password. Only relevant if Authentication Method is not NONE.


URL parameters in case of POST HTTP method. Each line in array should be in form of key=value.

Output Values • HTTP Response Code ( int )

HTTP return code. -1 will be returned if no HTTP connection could be made.

• HTML Response ( String )

Response as a string.



Find Text in HTML This action checks for the existence of a given text in the HTML that is retrieved from the specified URL.

Input Values

Mandatory

• Target URL ( String )

URL from which the HTML text is to be retrieved.

• Text To Match ( String )

Text to be searched for in the retrieved HTML.

Advanced

• Maximum Time To Wait ( int )

Maximum amount of time (in seconds) to wait before repeating the retrieval and search operations. This input value is relevant only if Repeat Until Found is set to True.


User name to use (leave empty to not use any user name).

• Is Unicode ( Boolean )

Whether the HTML that is to be retrieved from the target URL is written in Unicode:

True (default) - Written in Unicode.

False - Not written in Unicode.


Whether to use the POST or the GET method.

True - Use the POST method.

False (default) - Use the GET method.


URL parameters when the method is POST HTTP. Each line in the array should be in the form of key=value.

• Time To Wait Between Retries ( Long )

Amount of time (in seconds) to wait before repeating the retrieval and search operations. This input value is relevant only if Repeat Until Found is set to True.


Whether to use Preemptive Authentication when using the user name to login to the Web site.

Find Text in HTML


• Repeat Until Found ( Boolean )

Whether to repeatedly retrieve the HTML from the specified URL until the searched-for text is matched.


User password to use.

Output Values None



REST Operation This action performs REST operation for RESTful API calls.

Input Values

Mandatory

• URI

REST URI to access. URI must contain Scheme (http/https/..).

Advanced

• Check Response Code ( Boolean )

Whether actual response code should be matched against expected. If this flag is True and actual response code is not equal to expected, the step will fail.


Whether to use Preemptive Authentication when using user name to login to the Website.


HTTP Parameters in case of POST. Each line in array should be in form of key=value.

• Response File Path ( String )

File path to save the response to.




Can be set to each of the following methods: Basic, Digest or NTLM. These can be used to authenticate with http servers or proxies. NONE means no authentication is required.


User name for authentication. Only relevant if Authentication Method is not NONE.

• Http Headers ( String[] )

HTTP headers. Each line in array should be in form of key:value

• Read Timeout ( Integer )

Defines, in seconds, the default socket timeout to wait for data. A timeout value of zero is interpreted as an infinite timeout.

• Connection Timeout ( Integer )

Determines the seconds, in seconds, until a connection is established. Default value is 1 minute. A value of zero means the timeout is not used.

REST Operation


• Include HTTP Headers in Response ( Boolean )

Set to True to include HTTP headers in response.

• Body ( String )

HTTP Body in case of POST/PUT.



• Expected Code ( int )

Expected HTTP return code.



• Rest Verb ( HTTPMethodType )

REST verb to perform.

Output Values • Response as String ( String )

Response as string.

• HTTP Response Code ( int )

HTTP return code. If no HTTP connection could be made, -1 will be returned.

• Response Headers As String ( String )

Response headers as string.



SOAP Request This action accesses the WebService endpoint with the specified SOAP request, and saves the response in a file.

Input Values

Mandatory

• Response Filename ( String )

File name in which to store the response.

• End Point ( String )

WebService endpoint URL to access.

• Request Filename ( String )

File name of the XML file holding the SOAP request.

Advanced

• Connection Timeout ( Integer )

Determines the seconds, in seconds, until a connection is established. Default value is 1 minute. A value of zero means the timeout is not used.

• SOAPAction header ( String )

The optional SOAPAction header element, required for some Web services.




User name for authentication. Only relevant if Authentication Method is not NONE.


Can be set to each of the following methods: Basic, Digest or NTLM. These can be used to authenticate with HTTP servers or proxies. NONE means no authentication is required.



• Read Timeout ( Integer)

Defines the default socket timeout in seconds which is the timeout for waiting for data. A timeout value of zero is interpreted as an infinite timeout.


Whether to use Preemptive Authentication when using user name to login to the Website.

SOAP Request




Output Values • HTTP Response Code ( int)

HTTP return code. If no HTTP connection could be made, -1 will be returned.

• Response ( String )

Output parameter that will hold response of the request.


Chapter 27

XML Actions

In This Chapter

Delete an XML Attribute Using XPath ............................................................................................................. 655 Delete an XML Element Using XPath ............................................................................................................. 656 Execute an XPath Query ................................................................................................................................ 657 Insert an XML Attribute Using XPath .............................................................................................................. 658 Insert an XML Element Using XPath .............................................................................................................. 659 Update an XML Attribute Using XPath ............................................................................................................ 660 Update an XML Element Using XPath ............................................................................................................ 661

Delete an XML Attribute Using XPath This action deletes an XML attribute selected by an XPath query.

Input Values

Mandatory

• X Path Query ( String )

XPath query to select the element from where the specified attribute will be deleted.

• XML File Path ( String )

Path to the XML file on which to perform the operation.

• XML Attribute Name ( String )

Name of the XML attribute to delete.

Advanced

• Deletion Method ( XpathDeleteAttribute$DeleteMode )

Which action to take if XPath Query returns several found elements: First element, Last element, or all elements. Default value is DeleteFirst. Available options are: DeleteFirst, DeleteLast, DeleteAll.

Output Values • XML Attribute Found ( Boolean )

Whether the XML attribute was found and deleted.

Chapter 27 XML Actions


Delete an XML Element Using XPath This action deletes an XML Element selected by an XPath query.

Input Values

Mandatory


XPath query by which to select the element for deletion.


Path to the XML file on which to perform the operation.

Advanced

• Deletion Method ( XpathDelete$DeleteMode )

Which action to take if the XPath Query returns several elements: First element found, Last element found, or all of the elements that were found. Default value is DeleteFirst. Available options are DeleteFirst, DeleteLast, and DeleteAll.

Output Values • XML Element Found ( Boolean )

Whether the XML element was found and deleted.

Execute an XPath Query


Execute an XPath Query This action executes the specified XPath query on the specified XML file, and returns the XML elements values.

Input Values

Mandatory


Path to the XML file on which to perform operation.


XPath query to execute.

Output Values • XML Elements Count ( Integer )

Number of XML elements found.

• First XML Element Value ( String )

First value of the first XML element returned by execution of specified XPath query.

• XML Elements Values ( String[] )

Array of values of the XML elements returned by execution of specified XPath query.



Insert an XML Attribute Using XPath This action inserts the specified attribute in the element selected by the specified XPath query.

Input Values

Mandatory


Name of the XML attribute to insert.


Path to the XML file in which the attribute is to be inserted.


XPath query to select the element into which the specified attribute will be inserted.

• XML Attribute Value ( String )

Value to be assigned to the inserted attribute.

Advanced

• Insertion Method ( XpathInsertAttribute$InsertMode )

Action to take if the XPath Query returns several elements: First element found, Last element found, or all of the elements that were found. Default value is InsertToFirst. Available options are InsertToFirst, InsertToLast, and InsertToAll.


Whether the XML attribute was inserted.

Insert an XML Element Using XPath


Insert an XML Element Using XPath This action inserts the specified XML Element as a child of the XML Element selected by the XPath query.

Input Values

Mandatory


Path to the XML file in which the element is to be inserted.

• XML Element ( String )

XML Element to insert in string format. Explicit values can be set or a String Value Parameter can be used.


XPath query to select the element in which to insert the specified element.

Advanced

• Insertion Method ( XpathInsert$InsertMode InsertMode )

Action to take if the XPath query returns several elements: First element found, Last element found, or all of the elements that were found. Default value is InsertToFirst. Available options are InsertToFirst, InsertToLast, and InsertToAll.

• Inserted Element Location ( XpathInsert$InsertPlace )

Where to insert the new XML element relative to the existing XML element children. Default value is FirstChild. Available options are FirstChild, AfterFirstChild, BeforeFirstChild, and LastChild.

Output Values • XML Element Was Found ( Boolean )

Whether the XML Element was found.



Update an XML Attribute Using XPath This action updates the specified attribute's value on the selected XML Element by an XPath query.

Input Values

Mandatory


Query, composed in XPath-syntax, used to locate the XML element(s) in which the attribute is to be updated. For details, see http://www.3g.org/TR/xpath.

• New XML Attribute Value ( String )

New value to be assigned to the specified attribute.


Path to the XML file in which the attribute is to be updated.


XML attribute to be updated in the found element(s).

Advanced

• Update Method ( XpathUpdateAttribute$UpdateMode )

Action to take if the XPath Query returns several elements: First element found, Last element found or all of the elements that are found. Default value is UpdateFirst. Available options are UpdateFirst, UpdateLast, and UpdateAll.


Whether the XML attribute was indeed updated in one or more found elements.

Update an XML Element Using XPath


Update an XML Element Using XPath This action updates the value of an XML Element selected by an XPath query.

Input Values

Mandatory


XPath query that is to be used to select the element to be updated.

The query, composed in XPath syntax, used to locate the XML element to be updated. For more details, see http://www.3g.org/TR/xpath.

• New XML Element Value ( String )

New value to be assigned to the XML element.


Path to the XML file in which the element is to be updated.

Advanced

• Update Method ( XpathUpdate$UpdateMode )

Action to take if the XPath query returns several elements: First element found, Last element found, or all of the elements that are found. Default value is UpdateFirst. Available options are UpdateFirst, UpdateLast, and UpdateAll.

Output Values • XML Element Was Found ( Boolean )

Whether the value of the XML element was indeed updated in one or more instances.


Glos s ary Action

An action is a predefined operation that may be made available to and customized for application components. In the context of the flows created in Serena Release Automation, each such action becomes a step in the flow.

Administrator

The second highest of the four categories ("roles") of users who can work on a Serena Management Console, only having less authority than Superusers.

In addition to the privileges granted to Operators and Managers, Administrators can:

• Enable or disable processes, that is, make them available or unavailable for execution

• Define new users or, with the exception of Superusers, change the permission levels of existing users

Application

In the context of Serena Release Automation, an application is a high-level design construct whose design and ultimate execution allow achieving a fully-automated implementation of a server-based system. In Serena Release Automation, applications are developed in the Processes screen's Components tab.

Architecture

In the context of designing in Serena Release Automation, an architecture is a generic design of a possible physical configuration for the implementation of an application.

Component

A component is each one of the system-level software modules that is involved in the implementation of a server-based application designed in Serena Release Automation.

Environment

In Serena Release Automation, an environment, defined in the Processes screen's Processes tab, is one of any number of real, physical implementations of a specific architecture that was designed for the application. (By itself, an architecture still only specifies the abstract or generic server configurations defined for it.)

Flow

A flow is the grouping together of actions, made available to an application's component. This grouping together of actions specifies the chronological sequence in which two or more actions will occur. In

Glossary


addition, it may specify the conditional nature of the transition made from the completion of one action to the start of the next action in the sequence.

Implementation

The fully automated performance of all operations related to the deployment, maintenance, or other activities, on the software components participating in a server-based application. An implementation is achieved by executing some or all of the processes created for an architecture.

Manager

The third of four categories ("roles") of users who can work on Serena Release Automation, having less authority than both Superusers and Administrators.

In addition to the privileges granted to Operators, Managers can define or modify the:

• Environments created for the execution of processes

• Servers on which the executed processes will actually be implemented

• Mapping between actual physical servers and logical servers depicted in architectures

Operator

The lowest of the four categories ("roles") of users who can work on a Serena Management Console, having less authority than Superusers, Administrators, and Managers.

Operators can:

• Select which processes are to be run from Serena Management Console

• Execute processes

Predefined Parameter

Three parameters supplied by Serena that can be used only as private parameters: hostname, Node ID, and IP. These predefined parameters cannot be modified or deleted and are relevant for processes only.

Preliminary Check

Any of a number of action templates that can be used to establish prerequisites for hardware, software, and network components of the application being designed.

Preliminary checks are not actually part of the flow that you assemble for the implementation of a component. Rather, these checks are performed directly on the server on which the component resides, prior to execution of the flow in the context of a process run in a specific architecture environment.

Private Parameter

A parameter that can be integrated in the definition of actions, but which does not require any user input prior to implementation of an application. A parameter is made a private parameter by setting its Public use property to False. This is the default setting.

Glossary


Process

A process is a high-level sequence of planned activity involving one, multiple, or all components of an application. A process is assembled by instantiating the lower-level flows that have previously been created per component.

Public Parameter

A public parameter must be assigned appropriate values from the Run Processes screen when an application is to be implemented. A parameter is made a public parameter by setting its User Input property to True.

Serena Agent

Serena Agent is the Serena Release Automation module that receives the appropriate instructions passed to it by Serena Release Automation and implements them on the server to which it is linked.

Serena Center

Serena Release Automation's Serena Center is the central control mechanism that coordinates the implementation of packaged processes designed in Serena Release Automation.

When a process is actually executed, the appropriate data and instructions are channeled from the Serena Center via one or more dedicated Gateways to the Serena Execution Server that manages a specific Data Center. Handling data propagation for a specific group of servers, each Data Center also includes any number of Serena Agent modules, each of which controls a specific physical server involved in the execution of a process.

Step

A step is an action integrated into a flow created for an application component.

Superuser

The highest of the four categories ("roles") of users who can work on a Serena Management Console. Superusers have the authority to modify all aspects of the Serena Release Automation.

Workspace

A workspace is simply an archive (initially only a .dar file) written to the designated directory. As you design one or more applications stored in this workspace, data files and sub-directories are added to this workspace.


Index A

About this Document • 19 Access URL • 648 Action • 665 Activate JMX • 275 Add a Value to an Array • 349 Add Text to a File • 210, 467 Administrator • 665 Adminstrate Actions • 539 Amazon EC2 Actions • 23 AMI Actions • 23 Application • 665 Application Server Actions • 99 Architecture • 665 Attach MSMQ Rules to Trigger • 310 Authenticate User • 391

B

Bundle Tasks Actions • 32

C

Calculate Two Numbers • 277 Change Credentials for Windows Service • 293,

392 Change Mode of File or Folder • 212 Change Owner of File or Folder • 213, 393 Change Read Only Mode of File or Folder • 214 Check Free Disk Space • 457 Check Free Ports • 279 Check if File or Folder Exists • 215 Check if File or Folder Exists (SSH) • 427 Check if MSMQ Queue Exists • 311 Check if MSMQ Rule Exists • 312 Check if MSMQ Trigger Exists • 313 Check if Performance Log Exists • 363 Check if Process is Running • 378 Check if RPM Package is Installed • 261, 287 Check if Service Exists • 294

Check if Specific User has Administrative Rights • 394

Check if Specific User has Permissions on File or Folder • 216, 395

Check if User has Root Credentials • 288, 396 Check Number of CPUs • 458 Check OS Type • 346, 459 Check Service Status • 295 Check the Amount of Physical Memory • 460 Clone Action • 529 Cluster Actions • 483 Compare Two Arrays • 167 Compare Two Booleans • 168 Compare Two Dates • 169 Compare Two File Checksums • 170, 217, 314 Compare Two Folders • 171, 218 Compare Two Numbers • 173 Compare Two Strings • 174 Compare Two Values • 175 Comparison Actions • 167 Component • 665 Configuring for WAS Actions on Serena Agent

Machines • 119 Configuring for WLS Actions on Serena Agent

Machines • 99 Control Actions • 177 Convert Actions • 529, 531 Convert String to Number • 351 Copy File or Folder with Backup • 220 Copy File(s) or Folder(s) • 221 Copy Single File or Folder • 222 Create a Symbolic Link • 223 Create a Windows Registry Key • 296 Create Empty File • 224 Create Folder • 225 Create MSMQ Queue • 315 Create MSMQ Rule • 317 Create MSMQ Trigger • 320 Create Performance Log • 364 Create Random Number • 278 Create ZIP File • 226

Index


D

Database Actions • 181 Datacenter Actions • 486 Delay • 177 Delete a Windows Service • 297 Delete an XML Attribute Using XPath • 657 Delete an XML Element Using XPath • 658 Delete File • 227 Delete File or Folder • 228 Delete Folder • 229 Delete MSMQ Queue • 321 Delete MSMQ Rule • 322 Delete MSMQ Trigger • 323 Delete Performance Log • 365 Delete Windows Registry Folder • 298 Delete Windows Registry Key • 299 Deploy Actions • 529, 533 Detach MSMQ Rules from Trigger • 324 Disconnect Network Drive • 281 Download File (FTP Server/Network Drive) •

230 Download File (HTTP) • 231

E

EC2 - Add Permissions to Security Group • 78 EC2 - Allocate Address • 38 EC2 - Associate Address • 39 EC2 - Attach Volume • 92 EC2 - Bundle Instance • 32 EC2 - Cancel Bundle Task • 34 EC2 - Configure Health Check • 62 EC2 - Create Image • 23 EC2 - Create Key Pair • 59 EC2 - Create LoadBalancer • 64 EC2 - Create Security Group • 80 EC2 - Create Snapshot • 87 EC2 - Create Volume • 93 EC2 - Delete Key Pair • 60 EC2 - Delete LoadBalancer • 66 EC2 - Delete Security Group • 81 EC2 - Delete Snapshot • 88

EC2 - Delete Volume • 94 EC2 - Deregister Image • 25 EC2 - Detach Volume • 95 EC2 - Disable Availability Zones for

LoadBalancer • 67 EC2 - Disable Monitoring on Running Instances

• 44 EC2 - Disassociate Address • 40 EC2 - Enable Availability Zones for

LoadBalancer • 68 EC2 - Get Address Instance • 41 EC2 - Get Availability Zone Information • 69 EC2 - Get Bundle Task Information • 36 EC2 - Get Console Output • 45 EC2 - Get Health Check for Load Balancer • 70 EC2 - Get Image Information • 26 EC2 - Get Instance Information • 46 EC2 - Get Password • 48 EC2 - Get Snapshot Information • 89 EC2 - Get Volume Information • 96 EC2 - List All Addresses • 42 EC2 - List All Availability Zones • 72 EC2 - List All Instances • 49 EC2 - List All Key Pairs • 61 EC2 - List All LoadBalancers • 73 EC2 - List All Security Groups • 82 EC2 - List All Snapshots • 91 EC2 - List All Volumes • 98 EC2 - List Availability Zones in Load Balancer •

74 EC2 - List Instances in Load Balancer • 75 EC2 - List Security Group Permissions • 83 EC2 - Modify Instance Attributes • 50 EC2 - Monitor Instance • 52 EC2 - Reboot Instance • 53 EC2 - Register Image • 29 EC2 - Register Instance • 28, 76 EC2 - Release Address • 43 EC2 - Remove Permissions from Security

Group • 85 EC2 - Run Instance • 54

Index


EC2 - Start Existing AMI • 30 EC2 - Start Instance • 56 EC2 - Stop Instance • 57 EC2 - Terminate Instance • 58 EC2 - Unregister Instance • 77 Elastic IP Actions • 38 Email Action • 193 Environment • 665 Execute an XPath Query • 659 Execute JavaScript Code • 262 Execute SQL Query on IBM DB2 Server • 181 Execute SQL Query on Microsoft(c) SQL Server

• 184 Execute SQL Query on MySQL • 186 Execute SQL Query on Oracle(c) Database

Server • 188 Execute SQL Query on Sybase Database

Server • 190 Extract Column from ResultSet • 352 Extract Regular Expression Text from String •

469 Extract Text from a File • 233, 470 Extract Value From an Array • 353 Extract Value from ResultSet • 354 Extract ZIP • 234

F

F5 - Add Member to Pool • 195 F5 - Change Pool Member's Settings • 197 F5 - Create Pool • 199 F5 - Delete Pool • 200 F5 - Disable iRule • 201 F5 - Disable Member • 202 F5 - Enable iRule • 203 F5 - Enable Member • 204 F5 - List All Pool Members • 205 F5 - List All Pools • 206 F5 - Remove Member From Pool • 207 F5BigIP Actions • 195 File / Folder Actions • 209 Find Files or Folders • 235 Find Text in File • 237, 471

Find Text in HTML • 473, 650 Flow • 665

G

Get Array Length • 355 Get Current Date • 461 Get Current Date and Time • 462 Get Environment Variable Value • 347 Get File (SSH) • 239, 429 Get File Checksum • 240 Get File Details • 241 Get File or Folder from Remote Agent • 242 Get File Properties • 244 Get Index of a Value in an Array • 356 Get IPs of localhost • 282 Get Java System Property • 348 Get Microsoft Windows OS Details • 300 Get MSMQ Queue Info • 325 Get MSMQ Rule Information • 327 Get MSMQ Trigger Information • 328 Get Performance Counter Value • 366 Get Performance Counter Values • 367 Get Performance Counter Values Average Over

Time • 368 Get Unix/Linux OS Details • 289 Get Value from an INI file • 244, 303 Get Windows Registry Key Value • 301 Get Windows Service Properties • 302

H

Host Actions • 492

I

IIS - Add ISAPI Filter • 575 IIS - Add ISAPI WEB Service Extension Files •

577 IIS - Check Application Pool State • 578 IIS - Configure IP Access Restrictions to a

Virtual Directory • 579 IIS - Configure IP Access Restrictions to a Web

Site • 580 IIS - Create a Web Site • 581

Index


IIS - Create an Application Pool • 582 IIS - Create Virtual Directory • 583 IIS - Define Logging Schedule • 584 IIS - Define ODBC Logging Schedule • 585 IIS - Edit Allow/Prohibit Status of an ISAPI WEB

Service Extension • 586 IIS - Edit Allow/Prohibit Status of One or More

ISAPI WEB Service Extension Files • 587 IIS - Edit Authentication Methods on a Virtual

Directory • 588 IIS - Edit Authentication Methods on a Web Site

• 590 IIS - Edit ISAPI Filter • 592 IIS - Issue and Assign Server Certificate • 397,

593 IIS - Modify Application Pool - 'Health' Tab • 594 IIS - Modify Application Pool - 'Identity' Tab •

595 IIS - Modify Application Pool - 'Performance'

Tab • 596 IIS - Modify Application Pool - 'Recycling' Tab •

598 IIS - Modify Directory or Virtual Directory -

'Custom Errors' Tab • 601 IIS - Modify Directory or Virtual Directory -

'Documents' Tab • 602 IIS - Modify Directory or Virtual Directory -

'HTTP Headers' Tab • 603 IIS - Modify Directory or Virtual Directory -

'Virtual Directory' Tab • 604 IIS - Modify File or Directory - HTTP Headers

Tab • 599 IIS - Modify Virtual Dir Path • 600 IIS - Modify Web Site - ASP.NET Version • 616 IIS - Modify Web Site - 'Custom Errors' Tab •

608 IIS - Modify Web Site - 'Documents' Tab • 609 IIS - Modify Web Site - File-File Tab • 617 IIS - Modify Web Site - 'Home Directory' Tab •

610 IIS - Modify Web Site - 'HTTP Headers' Tab •

613 IIS - Modify Web Site - Logging Properties • 618

IIS - Modify Web Site - 'Performance' Tab • 614 IIS - Modify Web Site - 'Web Site' Tab • 615 IIS - Perform Operation on an Application Pool •

620 IIS - Prohibit All ISAPI WEB Service Extensions

• 621 IIS - Remove a Virtual Directory • 622 IIS - Remove a Web Site • 623 IIS - Remove an ISAPI Filter • 624 IIS - Remove an ISAPI WEB Service Extension

• 625 IIS - Remove ISAPI WEB Service Extension

Files • 626 IIS - Toggle SSL on a Virtual Directory • 398,

627 IIS - Toggle SSL on a Website • 399, 628 IIS Actions • 575 IIS7 - Application Pool Tasks • 629 IIS7 - Assign an Application to an Application

Pool • 630 IIS7 - Change an Application Pool for an

Application • 631 IIS7 - Check Application Pool State • 632 IIS7 - Check if a virtual directory exists • 633 IIS7 - Check if a website exists • 634 IIS7 - Check if an application exists • 635 IIS7 - Check if an application pool exists • 636 IIS7 - Create a Virtual Directory • 638 IIS7 - Create a Web Application • 639 IIS7 - Create a Website • 640 IIS7 - Create an Application Pool • 637 IIS7 - Delete a Virtual Directory • 642 IIS7 - Delete a Website • 643 IIS7 - Delete an Application Pool • 641 IIS7 - Edit Application Pool Identity • 644 IIS7 - Modify a Virtual Directory • 645 IIS7 - Modify Website Logging • 646 IIS7 - Run Appcmd • 647 IIS7 Actions • 629 Implementation • 666 INI File Actions • 303 Insert an XML Attribute Using XPath • 660

Index


Insert an XML Element Using XPath • 661 Install RPM Package • 264, 290 Install Windows Service • 265, 305 Installation Actions • 261 Instance Actions • 44 Intended Audience • 19 Introduction • 21

J

JMX Action • 275

K

Key Pair Actions • 59 Kill Process • 379 Kill Process by PID • 380

L

Linux/Unix Actions • 287 Load Balancer Actions • 62 Log to File on Serena Center • 246, 475

M

Maintenance Actions • 492 Manager • 666 Manipulate INI File • 247, 304 Map Network Drive • 283 Math Actions • 277 Migrate Actions • 539, 555 Modify MSDTC Settings • 306, 329 Modify MSMQ Queue • 331 Modify MSMQ Rule • 333 Modify MSMQ Trigger • 336 Modify Windows Service Properties • 308 Move File or Folder • 248 MSMQ Actions • 310

N

Network Actions • 279, 501

O

Operator • 666 OS Actions • 287

P

Package Actions • 433 Parameter Actions • 349 Performance Counter Actions • 363 Ping a Device • 284 Plain TCP String Request • 381 Power Actions • 497, 539, 560 Predefined Parameter • 666 Preface • 19 Preliminary Check • 666 Private Parameter • 666 Process • 667 Process Actions • 377 Public Parameter • 667 Put File (SSH) • 430 Put File or Folder in Remote Agent • 249

R

Read String Array from Text File • 251, 476 Read String from Text File • 252, 477 Related Documentation • 19 Remove Value from an Array • 357 Rename File or Folder • 253 Replace Text in File • 254, 478 Replace Text in Multiple Files • 255, 479 REST Operation • 652 Restart Agent • 463 Restart Host • 464 Restart Windows Service • 338 Retrieve Installed RPM Package Name by RPM

File • 266, 291 Run Command (SSH) • 431 Run Command Line • 267, 382 Run InstallAnywhere • 269 Run InstallAnywhere with Predefined Answer

File • 271 Run InstallShield with Answer File • 272 Run MSI Installer • 273, 337, 339 Run Process • 384 Run Windows Process • 340, 386

Index


S

Security Actions • 391 Security Group Actions • 78 Send Email • 193 Send SNMPv1 Trap • 401 Send SNMPv2c Trap • 403 Send SNMPv3 Trap • 404 Serena Agent • 667 Serena Center • 667 Service Actions • 443 Set Parameter Value - Boolean • 358 Set Parameter Value - Integer • 359 Set Parameter Value - String • 360 Set Performance Log Counters • 370 Snapshot Actions • 87, 539, 567 SNMP Actions • 401 SOAP Request • 654 Solaris - Add Package To Spool • 433 Solaris - Disable Service Instance • 443 Solaris - Enable Service Instance • 444 Solaris - Get Package Information • 434 Solaris - Get Service Information • 445 Solaris - Get Service Problems • 446 Solaris - Get Service Properties • 447 Solaris - Install Package • 436 Solaris - Install Service From Manifest • 448 Solaris - List All Files In Package • 437 Solaris - List All Packages • 438 Solaris - List All Service Instances • 449 Solaris - List All Service Processes • 450 Solaris - List Packages Referring To File • 439 Solaris - List Service's Dependencies • 451 Solaris - List Service's Dependents • 452 Solaris - Refresh Service Instance • 453 Solaris - Remove Package From Spool • 440 Solaris - Restart Service Instance • 454 Solaris - Uninstall Package • 441 Solaris - Uninstall Service • 455 Solaris - Verify Package Installation • 442 Source Control Actions • 407

SSH Actions • 427 Start Performance Log • 371 Start Windows Service • 342 Step • 667 Stop Performance Log • 372 Stop Windows Service • 343 Subversion (SVN) Actions • 407 Sun-Solaris Administration Actions • 433 Superuser • 667 SVN - Check Out • 407 SVN - Commit • 409 SVN - Create Branch / Tag • 410 SVN - Export • 411 SVN - Update • 412 Synchronize Two Folders • 256 System Actions • 457

T

Team Foundation Server (TFS) 2008 Actions • 413

Team Foundation Server (TFS) 2010 Actions • 419

Technical Support • 19 Telnet Session • 285, 388 Template Actions • 529 Test DSN Connection • 192 Text Actions • 467 TFS 2008 - Check In • 413 TFS 2008 - Check Out • 414 TFS 2008 - Create Workspace • 415 TFS 2008 - Delete a Workspace • 416 TFS 2008 - Get Version • 417 TFS 2010 - Check In • 419 TFS 2010 - Check Out • 420 TFS 2010 - Create Workspace • 421 TFS 2010 - Delete a Workspace • 423 TFS 2010 - Get Version • 425

U

Understanding Reference Terms • 21 Uninstall RPM Package • 274, 292 Update an XML Attribute Using XPath • 662

Index


Update an XML Element Using XPath • 663 Update Environment Variable • 344, 465 Update Performance Log Settings • 373 Update Value in Array (String) • 258, 480 Update Windows Registry Key • 345 URL Action • 648 User Input - Ask For Parameter Value • 361 User Input - Choose from Available Options •

362 User Input - Stop for Manual Operation • 178 Using the Actions Reference Guide • 21

V

Virtual Machine Actions • 539 VM - Add ESX Host To Cluster • 483 VM - Add ESX Host To VCenter • 486 VM - Add Existing Virtual Disk to VM • 539 VM - Add Host Virtual Adapter • 501 VM - Add Port Group • 503 VM - Add Virtual CD to VM • 541 VM - Add Virtual Disk To VM • 542 VM - Add Virtual Ethernet Card To VM • 505 VM - Add Virtual Switch • 506 VM - Change VM Memory Size • 543 VM - Clone VM • 529 VM - Convert Template To VM • 531 VM - Convert VM To Template • 532 VM - Create Custom VM • 533 VM - Create Snapshot • 567 VM - Create Typical VM • 535 VM - Create VM With Existing Disk • 544 VM - Deploy VM From Template • 537 VM - Destroy VM • 546 VM - Disconnect Host • 492 VM - Exit Host From Maintenance • 493 VM - Get All Host Virtual Adapters • 508 VM - Get All Virtual Machines • 547 VM - Get All Virtual Switches • 509 VM - Get All VM Controllers • 548 VM - Get All VM Disks • 549 VM - Get All VM Virtual Ethernet Cards • 510

VM - Get Clusters • 485 VM - Get Current Snapshot Name • 568 VM - Get Datacenters • 488 VM - Get Datastores • 489 VM - Get Host Virtual Adapter Config • 511 VM - Get Hosts • 490 VM - Get Port Group Config • 513 VM - Get Virtual Ethernet Card Config • 515 VM - Get Virtual Switch Config • 517 VM - Get VM Power State • 560 VM - List Snapshots • 569 VM - Migrate VM • 555 VM - Power Down Host To Standby • 497 VM - Power Off VM • 561 VM - Power On VM • 562 VM - Power Up Host From Standby • 498 VM - Put Host To Maintenance • 494 VM - Reboot Host • 499 VM - Reconnect Host • 495 VM - Register VM • 557 VM - Remove All Snapshots • 570 VM - Remove CD From VM • 550 VM - Remove Host • 491 VM - Remove Host Virtual Adapter • 519 VM - Remove Port Group • 521 VM - Remove Snapshot • 571 VM - Remove Virtual Disk From VM • 551 VM - Remove Virtual Ethernet Card From VM •

522 VM - Remove Virtual Switch • 523 VM - Rename Snapshot • 572 VM - Rename VM • 552 VM - Reset VM • 563 VM - Resume VM • 564 VM - Revert To Snapshot • 573 VM - Shutdown Guest • 565 VM - Shutdown Host • 500 VM - Suspend VM • 566 VM - Unregister VM • 559 VM - Update Host Virtual Adapter • 524 VM - Update Port Group • 526

Index


VM - Update Virtual Switch • 527 VM - Upgrade VM • 553 VM - Upgrade VMware Tools • 554 VMWare Actions • 483 Volume Actions • 92

W

Wait For Manual Restart • 179 Wait for Performance Counter Value • 375 Wait for Processes • 389 WAS - Check Environment Variable Exists • 119 WAS - Create Data Source for User Defined

JDBC Provider Action • 123 WAS - Create DB2 Data Source Action • 125 WAS - Create Derby Data Source Action • 127 WAS - Create Informix Data Source Action • 108 WAS - Create JAAS - J2C Authentication Data

Entry • 129 WAS - Create Microsoft SQL Server Data

Source Action • 131 WAS - Create Oracle Data Source Action • 133 WAS - Create Sybase Data Source Action • 135 WAS - Create/Update Environment Variable •

121 WAS - Delete Environment Variable • 137 WAS - Delete JAAS - J2C Authentication Data

Entry • 139 WAS - Get Environment Variable Value • 141 WAS - Get Managed Server Status • 143 WAS - Install Application • 145 WAS - Launch Script • 147 WAS - Start Application • 149 WAS - Start Managed Server(s) • 151 WAS - Start Server(s) • 153 WAS - Start Standalone Server • 155 WAS - Stop Application • 156 WAS - Stop Managed Server(s) • 158 WAS - Stop Server(s) • 160 WAS - Stop Standalone Server • 162 WAS - Uninstall Application • 163 WAS - Update Application • 164 Web Actions • 575

WebLogic Actions • 99 WebSphere Actions • 119 Windows Actions • 293 WLS - Create Data Source • 100 WLS - Delete Application • 102 WLS - Delete Data Source • 103 WLS - Deploy Installed Application • 104 WLS - Get Application State • 105 WLS - Get Server(s) State • 106 WLS - Install New Application • 107 WLS - Resume Server(s) • 111 WLS - Run WLST Script • 112 WLS - Shutdown Server(s) • 113 WLS - Start Application • 114 WLS - Start Server(s) • 115 WLS - Stop Application • 116 WLS - Suspend Server(s) • 117 WLS - Undeploy Application • 118 Workspace • 667 Write Array to Text File • 259, 481

X

XML Actions • 657

Z

ZIP Many Files • 260