PC 81 CommandLineReference

Command Line Reference
Informatica PowerCenter
(Version 8.1)
Informatica PowerCenter Command Line Reference Version 8.1 April 2006 Copyright (c) 19982006 Informatica Corporation. All rights reserved. Printed in the USA. This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable. The information in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Informatica Corporation does not warrant that this documentation is error free. Informatica, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerMart, SuperGlue, Metadata Manager, Informatica Data Quality and Informatica Data Explorer are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies, 1999-2002. All rights reserved. Copyright Sun Microsystems. All Rights Reserved. Copyright RSA Security Inc. All Rights Reserved. Copyright Ordinal Technology Corp. All Rights Reserved. Informatica PowerCenter products contain ACE (TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University and University of California, Irvine, Copyright (c) 1993-2002, all rights reserved. Portions of this software contain copyrighted material from The JBoss Group, LLC. Your right to use such materials is set forth in the GNU Lesser General Public License Agreement, which may be found at http://www.opensource.org/licenses/lgpl-license.php. The JBoss materials are provided free of charge by Informatica, as-is, without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Portions of this software contain copyrighted material from Meta Integration Technology, Inc. Meta Integration is a registered trademark of Meta Integration Technology, Inc. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). The Apache Software is Copyright (c) 1999-2005 The Apache Software Foundation. All rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit and redistribution of this software is subject to terms available at http://www.openssl.org. Copyright 1998-2003 The OpenSSL Project. All Rights Reserved. The zlib library included with this software is Copyright (c) 1995-2003 Jean-loup Gailly and Mark Adler. The Curl license provided with this Software is Copyright 1996-2004, Daniel Stenberg, <Daniel@haxx.se>. All Rights Reserved. The PCRE library included with this software is Copyright (c) 1997-2001 University of Cambridge Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel. The source for this library may be found at ftp://ftp.csx.cam.ac.uk/pub/software/programming/ pcre. InstallAnywhere is Copyright 2005 Zero G Software, Inc. All Rights Reserved. Portions of the Software are Copyright (c) 1998-2005 The OpenLDAP Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted only as authorized by the OpenLDAP Public License, available at http://www.openldap.org/software/release/license.html. This Software is protected by U.S. Patent Numbers 6,208,990; 6,044,374; 6,014,670; 6,032,158; 5,794,246; 6,339,775 and other U.S. Patents Pending. DISCLAIMER: Informatica Corporation provides this documentation as is without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of non-infringement, merchantability, or use for a particular purpose. The information provided in this documentation may include technical inaccuracies or typographical errors. Informatica could make improvements and/or changes in the products described in this documentation at any time without notice.
Table of Contents
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi Other Informatica Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii Visiting Informatica Customer Portal . . . . . . . . . . . . . . . . . . . . . . . . . xvii Visiting the Informatica Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii Visiting the Informatica Developer Network . . . . . . . . . . . . . . . . . . . . xvii Visiting the Informatica Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . xvii Obtaining Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Chapter 1: Using the Command Line Programs . . . . . . . . . . . . . . . . . . 1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Entering Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Syntax Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2: Configuring Environment Variables . . . . . . . . . . . . . . . . . . 5

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 INFA_CLIENT_RESILIENCE_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . 8 INFA_CODEPAGENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 INFA_DEFAULT_DATABASE_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . 10 INFA_DEFAULT_DOMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 INFA_DEFAULT_DOMAIN_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . 12 INFA_DEFAULT_DOMAIN_USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 INFA_REPCNX_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 INFATOOL_DATEFORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Encrypting Repository Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Setting the Repository User Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 3: infacmd Commands Reference . . . . . . . . . . . . . . . . . . . . . 19

Using infacmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Command Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
iii
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 infacmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 AddDomainLink. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 AddDomainNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 AddLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 AddNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 AssignedToLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 AssignLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 AssignRSToWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 ConvertLogFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 CreateGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 CreateIntegrationService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Integration Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Service Process Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 CreateRepositoryService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Repository Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 CreateWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Web Services Hub Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 DisableNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 DisableService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 DisableServiceProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 EnableNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 EnableService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 EnableServiceProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 GetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 GetLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 GetServiceOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 GetServiceProcessOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 GetServiceProcessStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 GetServiceStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 GetSessionLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 GetWorkflowLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 ListDomainLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 ListGridNodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 ListLicenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 ListNodeResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
iv Table of Contents
PurgeLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 RemoveDomainLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 RemoveGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 RemoveLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 RemoveNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 RemoveNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 RemoveService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 ShowLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 ShutdownNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 UnassignLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 UnassignRSWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 UnassociateDomainNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 UpdateDomainPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 UpdateGatewayInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 UpdateGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 UpdateIntegrationService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 UpdateLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 UpdateNodeOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 UpdateRepositoryService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 UpdateServiceProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 UpdateWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Chapter 4: infasetup Commands Reference . . . . . . . . . . . . . . . . . . . 113

Using infasetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Command Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 infasetup Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 BackupDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 DefineDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 DefineGatewayNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 DefineWorkerNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 RestoreDomain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 UpdateGatewayNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 UpdateWorkerNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Table of Contents
Chapter 5: pmcmd Commands Reference . . . . . . . . . . . . . . . . . . . . 133

Using pmcmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Running Commands in Command Line Mode . . . . . . . . . . . . . . . . . . . 134 Running Commands in Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . 136 Running in Wait Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Scripting pmcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Entering Command Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 pmcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 aborttask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 abortworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 getrunningsessionsdetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 getservicedetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 getserviceproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 getsessionstatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 gettaskdetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 getworkflowdetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 pingservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 recoverworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 scheduleworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 setfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 setnowait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 setwait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 showsettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 starttask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Using Parameter Files with starttask . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 startworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Using Parameter Files with startworkflow . . . . . . . . . . . . . . . . . . . . . . . 175 stoptask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 stopworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 unscheduleworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 unsetfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 waittask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
vi
Table of Contents
waitworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Chapter 6: pmrep Commands Reference . . . . . . . . . . . . . . . . . . . . . 189

Using pmrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Running Commands in Command Line Mode . . . . . . . . . . . . . . . . . . . 190 Running Commands in Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . 190 Running Commands in Normal Mode and Exclusive Mode . . . . . . . . . . 191 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Using Native Connect Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Scripting pmrep Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 pmrep Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 AddPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 AddToDeploymentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 AddUserToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 ApplyLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 BackUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 ChangePasswd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 CheckIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 CleanUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 ClearDeploymentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 CreateConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Specifying Database Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Specifying Database Code Page Information . . . . . . . . . . . . . . . . . . . . . 214 CreateDeploymentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 CreateFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Assigning Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 CreateLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 CreateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 DeleteConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 DeleteDeploymentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 DeleteFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 DeleteLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 DeployDeploymentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
vii
Table of Contents
DeployFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 EditUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Enabling and Disabling a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 ExecuteQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 FindCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 KillUserConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 ListAllGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 ListAllPrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 ListAllUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 ListGroupsForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 ListObjectDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 ListObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Listing Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Listing Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Listing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 ListTablesBySess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 ListUserConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 LsPrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 ModifyFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 ObjectExport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 ObjectImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 RegisterPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 Registering a Security Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 RegisterUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 RmGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 RmPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 RmUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 RmUserFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 ShowConnectionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 SwitchConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
viii Table of Contents
TruncateLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 UndoCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 Unregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 UnregisterPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 Unregistering an External Security Module . . . . . . . . . . . . . . . . . . . . . 283 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 UpdateConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 UpdateEmailAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 UpdateSeqGenVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 UpdateSrcPrefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 UpdateStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 UpdateTargPrefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 Validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Chapter 7: Working with pmrep Files . . . . . . . . . . . . . . . . . . . . . . . . 299

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300 Using the Persistent Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 Creating a Persistent Input File with pmrep . . . . . . . . . . . . . . . . . . . . . 301 Creating a Persistent Input File Manually . . . . . . . . . . . . . . . . . . . . . . 302 Using the Object Import Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303 Object Import Control File Parameters . . . . . . . . . . . . . . . . . . . . . . . . 305 Object Import Control File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 Importing Source Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308 Importing Multiple Objects into a Folder . . . . . . . . . . . . . . . . . . . . . . 309 Checking In and Labeling Imported Objects . . . . . . . . . . . . . . . . . . . . 309 Retaining Sequence Generator and Normalizer Values . . . . . . . . . . . . . 309 Importing Objects and Local Shortcut Objects to the Same Repository . 310 Importing Shortcut Objects from Another Repository . . . . . . . . . . . . . 310 Importing Objects to Multiple Folders . . . . . . . . . . . . . . . . . . . . . . . . 311 Importing Specific Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 Reusing and Replacing Dependent Objects . . . . . . . . . . . . . . . . . . . . . 312 Replacing Invalid Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 Renaming Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 Copying SAP Mappings and SAP Program Information . . . . . . . . . . . . 314 Applying Default Connection Attributes . . . . . . . . . . . . . . . . . . . . . . . 314
Table of Contents
ix
Resolving Object Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 Using the Deployment Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 Deployment Control File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 318 Deployment Control File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 Deploying the Latest Version of a Folder . . . . . . . . . . . . . . . . . . . . . . . 321 Deploying the Latest Version of a Deployment Group . . . . . . . . . . . . . 321 Listing Multiple Source and Target Folders . . . . . . . . . . . . . . . . . . . . . 322 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Table of Contents
List of Tables
Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table 1-1. Syntax Notation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1. Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1. infacmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2. AddDomainLink Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3. AddDomainNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4. AddLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5. AddNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6. AssignedToLicense Options and Arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7. AssignLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8. AssignRSToWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . 3-9. ConvertLogFile Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10. CreateGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11. CreateIntegrationService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 3-12. Integration Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13. Integration Service Process Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14. CreateRepositoryService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 3-15. Repository Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16. CreateWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17. Web Services Hub Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18. DisableNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19. DisableService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20. DisableServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21. EnableNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22. EnableService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23. EnableServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24. GetLastError Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25. GetLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26. GetServiceOption Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27. GetServiceProcessOption Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 3-28. GetServiceProcessStatus Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 3-29. GetServiceStatus Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30. GetSessionLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31. GetWorkflowLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32. Help Option and Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33. ListDomainLinks Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34. ListGridNodes Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35. ListLicenses Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36. ListNodeResources Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37. Ping Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38. PurgeLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 . 6 22 25 27 28 30 32 33 35 37 38 39 41 44 46 47 50 52 53 55 56 58 60 61 62 64 67 69 70 71 72 74 76 77 78 79 80 81 82
List of Tables
xi
Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table
3-39. RemoveDomainLink Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 3-40. RemoveGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 3-41. RemoveLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 3-42. RemoveNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 3-43. RemoveNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . 88 3-44. RemoveService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 3-45. ShowLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 3-46. ShutdownNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 3-47. UnassignLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 3-48. UnassignRSWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . 95 3-49. UnassociateDomainNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 97 3-50. UpdateDomainPassword Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 99 3-51. UpdateGatewayInfo Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 3-52. UpdateGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 3-53. UpdateIntegrationService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . .102 3-54. UpdateLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104 3-55. UpdateNodeOptions Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . .105 3-56. UpdateRepositoryService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . .107 3-57. UpdateServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . .109 3-58. UpdateWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . .111 4-1. infasetup Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 4-2. BackupDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117 4-3. DefineDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 4-4. DefineGatewayNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .122 4-5. DefineWorkerNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124 4-6. Help Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126 4-7. RestoreDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127 4-8. UpdateGatewayNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 4-9. UpdateWorkerNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .131 5-1. pmcmd Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135 5-2. Setting Defaults for Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 5-3. pmcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140 5-4. aborttask Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143 5-5. abortworkflow Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 5-6. connect Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147 5-7. getrunningsessionsdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . .150 5-8. getservicedetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 5-9. getserviceproperties Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154 5-10. getsessionstatistics Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 5-11. gettaskdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157 5-12. getworkflowdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159 5-13. help Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 5-14. pingservice Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
xii
List of Tables
Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table
5-15. recoverworkflow Options and Arguments . . . . . . . . . . . . . . 5-16. scheduleworkflow Options and Arguments . . . . . . . . . . . . . 5-17. setfolder Option and Argument . . . . . . . . . . . . . . . . . . . . . 5-18. starttask Options and Arguments . . . . . . . . . . . . . . . . . . . . 5-19. startworkflow Options and Arguments . . . . . . . . . . . . . . . . 5-20. stoptask Options and Arguments . . . . . . . . . . . . . . . . . . . . . 5-21. stopworkflow Options and Arguments . . . . . . . . . . . . . . . . . 5-22. unscheduleworkflow Options and Arguments . . . . . . . . . . . . 5-23. waittask Options and Arguments . . . . . . . . . . . . . . . . . . . . . 5-24. waitworkflow Options and Arguments . . . . . . . . . . . . . . . . . 6-1. Native Connect String Syntax . . . . . . . . . . . . . . . . . . . . . . . . 6-2. pmrep Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3. AddPrivilege Options and Arguments . . . . . . . . . . . . . . . . . . 6-4. AddToDeploymentGroup Options and Arguments . . . . . . . . 6-5. AddUserToGroup Options and Arguments . . . . . . . . . . . . . . 6-6. ApplyLabel Options and Arguments . . . . . . . . . . . . . . . . . . . 6-7. Backup Options and Arguments . . . . . . . . . . . . . . . . . . . . . . 6-8. ChangePasswd Options and Arguments . . . . . . . . . . . . . . . . . 6-9. CheckIn Options and Arguments . . . . . . . . . . . . . . . . . . . . . 6-10. ClearDeploymentGroup Options and Arguments . . . . . . . . . 6-11. Connect Options and Arguments . . . . . . . . . . . . . . . . . . . . 6-12. Create Options and Arguments . . . . . . . . . . . . . . . . . . . . . . 6-13. CreateConnection Options and Arguments . . . . . . . . . . . . . 6-14. Database Type Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15. Code Page ID by Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16. CreateDeploymentGroup Options and Arguments . . . . . . . . 6-17. CreateFolder Options and Arguments . . . . . . . . . . . . . . . . . 6-18. CreateGroup Options and Arguments . . . . . . . . . . . . . . . . . 6-19. CreateLabel Options and Arguments . . . . . . . . . . . . . . . . . . 6-20. CreateUser Options and Arguments . . . . . . . . . . . . . . . . . . 6-21. Delete Options and Arguments . . . . . . . . . . . . . . . . . . . . . . 6-22. DeleteConnection Options and Arguments . . . . . . . . . . . . . 6-23. DeleteDeploymentGroup Options and Arguments . . . . . . . . 6-24. DeleteFolder Option and Argument . . . . . . . . . . . . . . . . . . 6-25. DeleteLabel Options and Arguments . . . . . . . . . . . . . . . . . . 6-26. DeployDeploymentGroup Options and Arguments . . . . . . . 6-27. DeployFolder Options and Arguments . . . . . . . . . . . . . . . . 6-28. EditUser Options and Arguments . . . . . . . . . . . . . . . . . . . . 6-29. ExecuteQuery Options and Arguments . . . . . . . . . . . . . . . . 6-30. FindCheckout Options and Arguments . . . . . . . . . . . . . . . . 6-31. KillUserConnection Options and Arguments . . . . . . . . . . . . 6-32. ListObjectDependencies Option and Argument . . . . . . . . . . 6-33. ListObjectDependencies Options and Arguments . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. ..
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. ..
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. ..
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. ..
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
163 165 167 171 174 177 179 181 185 187 192 194 198 199 201 202 204 205 206 208 209 211 212 214 215 217 218 220 221 222 223 224 225 226 227 229 230 232 234 237 240 244 245
List of Tables
xiii
Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table
6-34. ListObjects Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249 6-35. Object Types and Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250 6-36. Transformation and Task Types to Use with pmrep . . . . . . . . . . . . . . . . . . . . . . .251 6-37. ListTablesBySess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254 6-38. LsPrivileges Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257 6-39. ModifyFolder Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258 6-40. Notify Option and Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .259 6-41. ObjectExport Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .260 6-42. ObjectImport Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262 6-43. Register Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263 6-44. RegisterPlugin Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .265 6-45. RegisterUser Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267 6-46. Restore Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269 6-47. RmGroup Option and Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271 6-48. RmPrivilege Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272 6-49. RmUser Option and Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273 6-50. RmUserFromGroup Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .274 6-51. Run Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .275 6-52. SwitchConnection Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .277 6-53. TruncateLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278 6-54. UndoCheckout Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279 6-55. Unregister Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280 6-56. UnregisterPlugin Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282 6-57. UpdateConnection Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .284 6-58. UpdateEmailAddr Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286 6-59. UpdateSeqGenVals Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .287 6-60. UpdateSrcPrefix Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289 6-61. UpdateTargPrefix Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292 6-62. Upgrade Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .293 6-63. Validate Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295 7-1. Object Import Control File Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . .305 7-2. Object Types for OBJECTTYPENAME Attribute . . . . . . . . . . . . . . . . . . . . . . . . .306 7-3. Object Import Control File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .307 7-4. Deployment Control File Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . .318
xiv
List of Tables
Preface
Welcome to PowerCenter, the Informatica software product that delivers an open, scalable data integration solution addressing the complete life cycle for all data integration projects including data warehouses, data migration, data synchronization, and information hubs. PowerCenter combines the latest technology enhancements for reliably managing data repositories and delivering information resources in a timely, usable, and efficient manner. The PowerCenter repository coordinates and drives a variety of core functions, including extracting, transforming, loading, and managing data. The Integration Service can extract large volumes of data from multiple platforms, handle complex transformations on the data, and support high-speed loads. PowerCenter can simplify and accelerate the process of building a comprehensive data warehouse from disparate data sources.
xv
About This Book

The Command Line Reference is written for PowerCenter administrators and developers who manage the repositories and administer the domain and services. This guide assumes you have knowledge of the operating systems in your environment. This guide also assumes you are familiar with the interface requirements for the supporting applications. The material in this book is also available online.
Document Conventions
This guide uses the following formatting conventions:
If you see It means The word or set of words are especially emphasized. Emphasized subjects. This is the variable name for a value you enter as part of an operating system command. This is generic text that should be replaced with user-supplied values. The following paragraph provides additional facts. The following paragraph provides suggested uses. The following paragraph notes situations where you can overwrite or corrupt data, unless you follow the specified procedure. This is a code example. This is an operating system command you enter from a prompt to run a task.
italicized text boldfaced text

italicized monospaced text
Note: Tip: Warning:

monospaced text bold monospaced text
xvi
Preface
Other Informatica Resources

In addition to the product manuals, Informatica provides these other resources:

Informatica Customer Portal Informatica web site Informatica Developer Network Informatica Knowledge Base Informatica Technical Support
Visiting Informatica Customer Portal

As an Informatica customer, you can access the Informatica Customer Portal site at http://my.informatica.com. The site contains product information, user group information, newsletters, access to the Informatica customer support case management system (ATLAS), the Informatica Knowledge Base, and access to the Informatica user community.
Visiting the Informatica Web Site

You can access the Informatica corporate web site at http://www.informatica.com. The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services.
Visiting the Informatica Developer Network

You can access the Informatica Developer Network at http://devnet.informatica.com. The Informatica Developer Network is a web-based forum for third-party software developers. The site contains information about how to create, market, and support customer-oriented add-on solutions based on interoperability interfaces for Informatica products.
Visiting the Informatica Knowledge Base

As an Informatica customer, you can access the Informatica Knowledge Base at http://my.informatica.com. Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products. You can also find answers to frequently asked questions, technical white papers, and technical tips.
Obtaining Technical Support

There are many ways to access Informatica Technical Support. You can contact a Technical Support Center by using the telephone numbers listed the following table, you can send email, or you can use the WebSupport Service.
Preface
xvii
Use the following email addresses to contact Informatica Technical Support:

support@informatica.com for technical inquiries support_admin@informatica.com for general customer service requests
WebSupport requires a user name and password. You can request a user name and password at http://my.informatica.com.
North America / South America Informatica Corporation Headquarters 100 Cardinal Way Redwood City, California 94063 United States Europe / Middle East / Africa Informatica Software Ltd. 6 Waltham Park Waltham Road, White Waltham Maidenhead, Berkshire SL6 3TN United Kingdom Asia / Australia Informatica Business Solutions Pvt. Ltd. Diamond District Tower B, 3rd Floor 150 Airport Road Bangalore 560 008 India Toll Free Australia: 00 11 800 4632 4357 Singapore: 001 800 4632 4357 Standard Rate India: +91 80 5112 5738
Toll Free 877 463 2435
Toll Free 00 800 4632 4357
Standard Rate United States: 650 385 5800
Standard Rate Belgium: +32 15 281 702 France: +33 1 41 38 92 26 Germany: +49 1805 702 702 Netherlands: +31 306 022 797 United Kingdom: +44 1628 511 445
xviii
Preface
Chapter 1
Using the Command Line Programs

This chapter includes the following topic:
Overview, 2
Overview
PowerCenter includes command line programs that you use to perform tasks from any machine in the PowerCenter environment. The command line programs allow you to run a subset of tasks that you can complete in the Administration Console. For example, you can enable or disable a Repository Service from the Administration Console or the command line program, infacmd. PowerCenter includes the following command line programs:

infacmd. Use infacmd to access the PowerCenter application services. For more information about infacmd, see infacmd Commands Reference on page 19. infasetup. Use infasetup to perform installation tasks such as defining a node or a domain. For more information about infasetup, infasetup Commands Reference on page 113. pmcmd. Use pmcmd to manage workflows. You can start, stop, schedule, and monitor workflows using pmcmd. For more information about pmcmd, see pmcmd Commands Reference on page 133. pmrep. Use pmrep to perform repository administration tasks such as listing repository objects, creating and editing groups, and restoring and deleting repositories. For more information about pmrep, see pmrep Commands Reference on page 189.
For ease of use, you can configure environment variables that apply each time you run the command line programs. For example, you can set an environment variable for the default domain name, domain user, and password to avoid typing the options at the command line. For more information about environment variables, see Configuring Environment Variables on page 5.
Entering Options and Arguments

Each command line program requires a set of options and arguments. These include user name, password, domain name, and connection information. Use the following rules when you enter command options and arguments:
To enter options, type a hyphen followed by one letter, two letters, or a word, depending on the command line program syntax. For example, the pmrep Connect command uses a single letter option for the repository name:
connect -r <repository_name>
Enter options in any order. The first word after the option is the argument. Most options require arguments. You must separate options from arguments with a single space when using pmcmd or infacmd. You do not have to separate options from arguments when using pmrep.
Chapter 1: Using the Command Line Programs
If any argument contains more than one word, enclose the argument in double quotes. For pmcmd, you can also use single quotes. The command line programs ignore quotes that do not enclose an argument. Unmatched quotes result in an error.
Syntax Notation
Table 1-1 describes the notation used in this book to show the syntax for all PowerCenter command line programs:
Table 1-1. Syntax Notation Convention -x Description Option placed before a argument. This designates the parameter you enter. For example, to enter the user name for pmcmd, type -u or -user followed by the user name. Required option. If you omit a required option, the command line program returns an error message. Select between required options. For the command to run, you must select from the listed options. If you omit a required option, the command line program returns an error message. In pmrep, curly brackets denote groupings of required options, as in the following example:
killuserconnection {-i <connection_id> | -n <user_name> | -a (kill all)}
<x> <x | y >
{x | y}
If a pipe symbol ( | ) separates options, you must specify exactly one option. If options are not separated by pipe symbols, you must specify all the options. [x] Optional parameter. The command runs whether or not you enter optional parameters. For example, the help command has the following syntax:
Help [Command]
If you enter a command, the command line program returns information on that command only. If you omit the command name, the command line program returns a list of all commands. [x|y] Select between optional parameters. For example, many commands in pmcmd run in either the wait or nowait mode.
[-wait|-nowait]
If you specify a mode, the command runs in the specified mode. The command runs whether or not you enter the optional parameter. If you do not specify a mode, pmcmd runs the command in the default nowait mode. << x | y>| <a | b>> (text) When a set contains subsets, the superset is indicated with bold brackets < >. A bold pipe symbol (|) separates the subsets. In pmrep, parentheses surround descriptive text, such as the list of the possible values for an argument or an explanation for an option that does not take an argument.
Overview
Chapter 1: Using the Command Line Programs
Chapter 2
Configuring Environment Variables

This chapter includes the following topics:

Overview, 6 INFA_CLIENT_RESILIENCE_TIMEOUT, 8 INFA_CODEPAGENAME, 9 INFA_DEFAULT_DATABASE_PASSWORD, 10 INFA_DEFAULT_DOMAIN, 11 INFA_DEFAULT_DOMAIN_PASSWORD, 12 INFA_DEFAULT_DOMAIN_USER, 13 INFA_REPCNX_INFO, 14 INFATOOL_DATEFORMAT, 15 Encrypting Repository Passwords, 16 Setting the Repository User Name, 17
Overview
You can configure environment variables for the command line programs. For example, you can set environment variables to encrypt passwords, configure time and date display options, or store the default login information for a domain. The environment variables you configure are all optional. If you are running pmcmd or pmrep in interactive mode, you must exit from the command line program and then reconnect to use changed environment variables. On Windows, you can configure these environment variables as either user or system variables. For information about setting environment variables on Windows, consult the Windows documentation. Table 2-1 describes environment variables you can configure to use with the command line programs:
Table 2-1. Environment Variables Command Line Programs infacmd pmcmd pmrep pmcmd pmrep infasetup
Environment Variable INFA_CLIENT_RESILIENCE_TIMEOUT
Description Limits the number of seconds you want the command line programs to spend establishing a connection to the domain or service. For more information, see INFA_CLIENT_RESILIENCE_TIMEOUT on page 8. Configures the character set pmcmd and pmrep use. For more information, see INFA_CODEPAGENAME on page 9. Stores the default user name password for the domain configuration database. For more information, see INFA_DEFAULT_DATABASE_PASSWORD on page 10. Stores the default domain name. For more information, see INFA_DEFAULT_DOMAIN on page 11. Stores the default user name password for the domain. For more information, see INFA_DEFAULT_DOMAIN_PASSWORD on page 12. Stores the default user name for the domain. For more information, see INFA_DEFAULT_DOMAIN_USER on page 13. Stores the name of the repository connection file. For more information, see INFA_REPCNX_INFO on page 14. Configures the way pmcmd displays the date and time. For more information, see INFATOOL_DATEFORMAT on page 15.
INFA_CODEPAGENAME
INFA_DEFAULT_DATABASE_PASSWORD
INFA_DEFAULT_DOMAIN
infacmd pmcmd pmrep infacmd
INFA_DEFAULT_DOMAIN_PASSWORD
INFA_DEFAULT_DOMAIN_USER
infacmd
INFA_REPCNX_INFO
pmrep
INFATOOL_DATEFORMAT
pmcmd
Chapter 2: Configuring Environment Variables
Table 2-1. Environment Variables Command Line Programs pmcmd pmrep pmcmd pmrep
Environment Variable
Description Encrypts and stores the repository password. For more information, see Encrypting Repository Passwords on page 16. Stores the repository user name. For more information, see Setting the Repository User Name on page 17.
<Password_Environment_Variable>
<User_Name_Environment_Variable>
Overview
INFA_CLIENT_RESILIENCE_TIMEOUT
Command Line Programs: infacmd pmcmd pmrep
You can set the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT to limit the number of seconds the command line programs spend establishing connections to the domain or service. The default time is 180 seconds if you do not set this environment variable.
To configure INFA_CLIENT_RESILIENCE_TIMEOUT on UNIX: 1.
In a UNIX C shell environment, type:

setenv INFA_CLIENT_RESILIENCE_TIMEOUT <number of seconds>
In a UNIX Bourne shell environment, type:

INFA_CLIENT_RESILIENCE_TIMEOUT = <number of seconds> export INFA_CLIENT_RESILIENCE_TIMEOUT To configure INFA_CLIENT_RESILIENCE_TIMEOUT on Windows: 1.
Enter the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT, and set the value to the number of seconds you want the command line programs to spend establishing a connection to the domain or service. For information about setting environment variables on Windows, consult the Windows documentation.
INFA_CODEPAGENAME
Command Line Programs: pmcmd pmrep
pmcmd and pmrep send commands in Unicode and use the code page of the host machine unless you set the code page environment variable, INFA_CODEPAGENAME, to override it. If you set INFA_CODEPAGENAME for pmcmd, the code page must be compatible with the Integration Service code page. If you set INFA_CODEPAGENAME for pmrep, the code page name must be compatible with the repository code page. If you set INFA_CODEPAGENAME on the machine where you run pmcmd and pmrep, the code page must be compatible with the Integration Service and the repository code pages. If the code pages are not compatible, the command might fail. For more information about code page compatibility, see Understanding Globalization and Code Pages in the Administrator Guide.
To configure INFA_CODEPAGENAME on UNIX: 1.

setenv INFA_CODEPAGENAME <code page name>

INFA_CODEPAGENAME = <code page name> export INFA_CODEPAGENAME To configure INFA_CODEPAGENAME on Windows: 1.
Enter the environment variable INFA_CODEPAGENAME, and set the value to the code page name. For information about setting environment variables on Windows, consult the Windows documentation.
INFA_CODEPAGENAME
INFA_DEFAULT_DATABASE_PASSWORD
Command Line Program: infasetup
Some infasetup commands require a domain configuration database password. You can provide this password as an option with infasetup, or you can store it as the environment variable INFA_DEFAULT_DATABASE_PASSWORD. Use the following steps as a guideline to use an encrypted password as an environment variable: 1. Use the command line program pmpasswd to encrypt the database user password. pmpasswd generates and displays the encrypted password. For example, if you enter the password monday, it encrypts to f/wRb5PZsZnqESTDPeos7Q==. 2. Configure the password environment variable to set the encrypted value.
To configure INFA_DEFAULT_DATABASE_PASSWORD on UNIX: 1.
At the command line, type:

pmpasswd <database password>
pmpasswd returns the encrypted password.

2.

setenv INFA_DEFAULT_DATABASE_PASSWORD <encrypted password>

INFA_DEFAULT_DATABASE_PASSWORD = <encrypted password> export INFA_DEFAULT_DATABASE_PASSWORD To configure INFA_DEFAULT_DATABASE_PASSWORD on Windows: 1.

pmpasswd <database password>

2.
Enter the environment variable INFA_DEFAULT_DATABASE_PASSWORD, and set the value to the encrypted password. For information about setting environment variables on Windows, consult the Windows documentation.
10
INFA_DEFAULT_DOMAIN
Command Line Programs: infacmd pmcmd pmrep
The command line programs require a domain name. You can provide the domain name as an option with the command line programs, or you can store it as the environment variable INFA_DEFAULT_DOMAIN. If you have more than one domain, choose a default domain.
To configure INFA_DEFAULT_DOMAIN on UNIX: 1.

setenv INFA_DEFAULT_DOMAIN <domain name>

INFA_DEFAULT_DOMAIN = <domain name> export INFA_DEFAULT_DOMAIN To configure INFA_DEFAULT_DOMAIN on Windows: 1.
Enter the environment variable INFA_DEFAULT_DOMAIN, and set the value to the domain name. For information about setting environment variables on Windows, consult the Windows documentation.
INFA_DEFAULT_DOMAIN
11
INFA_DEFAULT_DOMAIN_PASSWORD
Command Line Program: infacmd
Most infacmd commands require a domain user password. You can provide a domain user password as an option with infacmd, or you can store it as the environment variable INFA_DEFAULT_DOMAIN_PASSWORD. Use the following steps as a guideline to use an encrypted password as an environment variable: 1. Use the command line program pmpasswd to encrypt the domain user password. pmpasswd generates and displays the encrypted password. For example, if you enter the password monday, it encrypts to f/wRb5PZsZnqESTDPeos7Q==. 2. Configure the password environment variable to set the encrypted value.
To configure INFA_DEFAULT_DOMAIN_PASSWORD on UNIX: 1.

pmpasswd <domain password>

2.

setenv INFA_DEFAULT_DOMAIN_PASSWORD <encrypted password>

INFA_DEFAULT_DOMAIN_PASSWORD = <encrypted password> export INFA_DEFAULT_DOMAIN_PASSWORD To configure INFA_DEFAULT_DOMAIN_PASSWORD on Windows: 1.

pmpasswd <domain password>

2.
Enter the environment variable INFA_DEFAULT_DOMAIN_PASSWORD, and set the value to the encrypted password. For information about setting environment variables on Windows, consult the Windows documentation.
12
Command Line Program: infacmd
Most infacmd commands require a domain user name. You can provide a domain user name as an option with infacmd, or you can store it as the environment variable INFA_DEFAULT_DOMAIN_USER.
To configure INFA_DEFAULT_DOMAIN_USER on UNIX: 1.

setenv INFA_DEFAULT_DOMAIN_USER <user name>

INFA_DEFAULT_DOMAIN_USER = <user name> export INFA_DEFAULT_DOMAIN_USER To configure INFA_DEFAULT_DOMAIN_USER on Windows: 1.
Enter the environment variable INFA_DEFAULT_DOMAIN_USER, and set the value to the default user name. For information about setting environment variables on Windows, consult the Windows documentation.
13
INFA_REPCNX_INFO
Command Line Program: pmrep
When you run pmrep in command line mode or from a script, it stores repository connection information in a file, pmrep.cnx. pmrep uses the information in this file to reconnect to the repository. The INFA_REPCNX_INFO environment variable stores the file name and file path for the repository connection file. Use this variable when scripts that issue pmrep commands run simultaneously, and the scripts connect to different repositories. In each shell, specify a different repository connection file. This prevents a script from overwriting the connection information used by another script. If you do not set this variable, pmrep stores connection information in pmrep.cnx in the directory where you start pmrep.
To configure INFA_REPCNX_INFO on UNIX: 1.

setenv INFA_REPCNX_INFO <file name>

INFA_REPCNX_INFO = <file name> export INFA_REPCNX_INFO To configure INFA_REPCNX_INFO on Windows: 1.
In a DOS shell, type:

set INFA_REPCNX_INFO = <file name>
Note: If you run multiple pmrep scripts, set this environment variable for the DOS shell,
not for the machine.
14
INFATOOL_DATEFORMAT
Command Line Program: pmcmd
Use this environment variable to customize the way pmcmd displays the date and time. Enter the date format string in DY MON DD HH24:MI:SS YYYY format. pmcmd verifies that the string is a valid format. If the format string is not valid, the Integration Service generates a warning message and displays the date in the format DY MON DD HH24:MI:SS YYYY.
To configure INFATOOL_DATEFORMAT on UNIX: 1.

setenv INFATOOL_DATEFORMAT <date/time format string>

INFATOOL_DATEFORMAT = <date/time format string> export INFATOOL_DATEFORMAT To configure INFATOOL_DATEFORMAT on Windows: 1.
Enter the environment variable INFATOOL_DATEFORMAT, and set the value to the display format string. For information about setting environment variables on Windows, consult the Windows documentation.
INFATOOL_DATEFORMAT
15
Encrypting Repository Passwords

You can encrypt passwords and create an environment variable to use with pmcmd and pmrep. For example, you can encrypt the repository and database passwords for pmrep to maintain security when using pmrep in scripts. In addition, you can create an environment variable to store the encrypted password. Use the following steps as a guideline to use an encrypted password as an environment variable: 1. Use the command line program pmpasswd to encrypt the repository password. pmpasswd generates and displays the encrypted password. For example, if you enter the password monday, the password encrypts to f/wRb5PZsZnqESTDPeos7Q==. 2. Configure the password environment variable to set the encrypted value.
To configure a password as an environment variable on UNIX: 1.

pmpasswd <repository password>

2.

setenv <Password_Environment_Variable> <encrypted password>

<Password_Environment_Variable> = <encrypted password> export <Password_Environment_Variable>
You can assign the environment variable any valid UNIX name.
To configure a password as an environment variable on Windows: 1.

pmpasswd <repository password>

2.
Enter the password environment variable in the Variable field. Enter the encrypted password in the Value field. For information about setting environment variables on Windows, consult the Windows documentation.
16
Setting the Repository User Name

For pmcmd and pmrep, you can create an environment variable to store the repository user name.
To configure a user name as an environment variable on UNIX: 1.

setenv <User_Name_Environment_Variable> <user name>

<User_Name_Environment_Variable> = <user name> export <User_Name_Environment_Variable>
You can assign the environment variable any valid UNIX name.
To configure a user name as an environment variable on Windows: 1.
Enter the user name environment variable in the Variable field. Enter the repository user name in the Value field. For information about setting environment variables on Windows, consult the Windows documentation.
Setting the Repository User Name
17
18
Chapter 3
infacmd Commands Reference


Using infacmd, 20 infacmd Commands, 22
19
Using infacmd
infacmd is a command line program that allows you to administer PowerCenter domains and services. Use infacmd to administer the following objects and services:
Application services and processes. Create, enable, disable, remove, and get the status of application services and the associated service processes. Ping services. Update service processes and service process options. Domain gateway. Update the gateway node connectivity information. Licenses. Add, remove, assign, unassign, and list licenses. Show license information. Log events. Get and purge log events. Get session and workflow logs. Convert log files from binary to text format. Nodes. Update, ping, shut down, and remove nodes. Fetch node names. Add, enable, list, disable, and remove node resources. Grids. Create and remove grids. List nodes in a grid. Domains. Link domains and remove domain links. Change the domain administrator password.
Running Commands
You invoke infacmd from the command line. You can issue commands directly or from a script, batch file, or other program.
To run infacmd commands: 1.
At the command prompt, switch to the directory where the infacmd executable is located. By default, infacmd installs in the server\bin directory. You can also install infacmd from the PowerCenter Utilities CD. For more information, see PowerCenter Documentation and Utilities Installation in the Installation and Configuration Guide.
2.
Enter infacmd on Windows or infacmd.sh on UNIX followed by the command name and its required options and arguments. The command names are not case-sensitive. For example:
infacmd(.sh) command_name [-option1] argument_1 [-option2] argument_2...
Command Options
When you run infacmd, you enter options for each command, followed by the required arguments. For example, most commands require that you enter the domain name, domain user name, and password using command options. Command options are preceded with a hyphen and are not case-sensitive. Arguments follow the option. To enter an argument that contains a space or other non-alphanumeric character, enclose the argument in quotation marks.
20
Chapter 3: infacmd Commands Reference
For example, the following command adds file/directory resource BackupDir to node Node1 in domain MyDomain on Windows:
infacmd AddNodeResource -dn MyDomain -un AdminUser -pd password -nn Node1 -rt "File Directory" -rn BkupDir
On UNIX, the same command is as follows:

infacmd.sh AddNodeResource -dn MyDomain -un AdminUser -pd password -nn Node1 -rt "File Directory" -rn BkupDir
For a list of command options and arguments, see the individual commands in infacmd Commands on page 22. If you omit or incorrectly enter one of the required options, the command fails and infacmd returns an error message. For a description of infacmd error messages, see the Troubleshooting Guide. You can use environment variables for some command options with infacmd. For example, you can store the default user name and password for a domain as environment variables so that you do not have to enter them using command options. Configure these variables before you use infacmd. For more information about configuring environment variables to use with infacmd, see Configuring Environment Variables on page 5.
Return Codes
infacmd indicates the success or failure of a command with a return code. Return code (0) indicates that the command succeeded. Return code (-1) indicates that the command failed. Use the DOS or UNIX echo command immediately after running an infacmd command to see the return code for the command:

In a DOS shell: echo %ERRORLEVEL% In a UNIX Bourne or Korn shell: echo $? In a UNIX C shell: echo $status
Using infacmd
21
infacmd Commands
Table 3-1 describes the infacmd commands. For more information about using infacmd commands, see Using infacmd on page 20.
Table 3-1. infacmd Commands Command AddDomainLink AddDomainNode AddLicense AddNodeResource AssignedToLicense AssignLicense AssignRSToWSHubService ConvertLogFile CreateGrid CreateIntegrationService CreateRepositoryService CreateWSHubService DisableNodeResource DisableService DisableServiceProcess EnableNodeResource EnableService EnableServiceProcess Description Records connection information so that you can access another domain. For more information, see AddDomainLink on page 25. Adds a node to a domain. For more information, see AddDomainNode on page 27. Adds a license to a domain. For more information, see AddLicense on page 28. Adds a PowerCenter resource to a node. For more information, see AddNodeResource on page 30. Lists the services assigned to a license. For more information, see AssignedToLicense on page 32. Assigns a service to a license. For more information, see AssignLicense on page 33. Associates a repository with a Web Services Hub Service in a domain. For more information, see AssignRSToWSHubService on page 35. Converts binary log files to readable text files. For more information, seeConvertLogFile on page 37. Creates a grid and assigns nodes to the grid. For more information, see CreateGrid on page 38. Creates an Integration Service in a domain. For more information, see CreateIntegrationService on page 39. Creates a Repository Service in a domain. For more information, see CreateRepositoryService on page 46. Creates a Web Services Hub Service in a domain. For more information, see CreateWSHubService on page 50. Disables a node resource. For more information, see DisableNodeResource on page 53. Disables the service corresponding to service name. For more information, see DisableService on page 55. Disables the service process on a specified node. For more information, see DisableServiceProcess on page 56. Enables a user defined or connection resource. For more information, see EnableNodeResource on page 58. Enables the service corresponding to the service name. For more information, see EnableService on page 60. Enables the service process on a specified node. For more information, see EnableServiceProcess on page 61.
22
Table 3-1. infacmd Commands Command GetLastError GetLog GetServiceOption GetServiceProcessOption GetServiceProcessStatus GetServiceStatus GetSessionLog GetWorkflowLog Help ListDomainLinks ListGridNodes ListLicenses ListNodeResources Ping PurgeLog RemoveDomainLink RemoveGrid RemoveLicense RemoveNode RemoveNodeResource Description Fetches most recent error messages for an application service. For more information, see GetLastError on page 62. Fetches log events based on criteria you provide. For more information, see GetLog on page 64. Fetches the value of a service property. For more information, see GetServiceOption on page 67. Returns the value of the service process property. For more information, see GetServiceProcessOption on page 69. Returns the state of a service process. For more information, see GetServiceProcessStatus on page 70. Returns the state of a service. For more information, see GetServiceStatus on page 71. Fetches log events for the session you specify. For more information, see GetSessionLog on page 72. Fetches log events for the workflow you specify. For more information, see GetWorkflowLog on page 74. Returns the syntax for the command you specify. Lists the options for the command. For more information, see Help on page 76. Lists the domains that the local domain can connect to. For more information, see ListDomainLinks on page 77. Lists the nodes assigned to a grid. For more information, see ListGridNodes on page 78. Lists licenses in a domain. For more information, see ListLicenses on page 79. Lists all resources defined for node. For more information, see ListNodeResources on page 80. Pings a domain or application service. For more information, see Ping on page 81. Purges log events based on criteria you provide. For more information, see PurgeLog on page 82. Removes connection information so that you can no longer access another domain. For more information, see RemoveDomainLink on page 83. Removes a grid from a domain. For more information, see RemoveGrid on page 84. Removes a license from a domain. For more information, see RemoveLicense on page 85. Removes a node from a domain. For more information, see RemoveNode on page 87. Removes a resource from a node. For more information, see RemoveNodeResource on page 88.
infacmd Commands
23
Table 3-1. infacmd Commands Command RemoveService ShowLicense ShutdownNode UnassignLicense UnassignRSWSHubService UnassociateDomainNode UpdateDomainPassword UpdateGatewayInfo UpdateGrid UpdateIntegrationService UpdateLicense UpdateNodeOptions UpdateRepositoryService UpdateServiceProcess UpdateWSHubService Description Removes an application service from a domain. For more information, see RemoveService on page 90. Displays license information. For more information, see ShowLicense on page 91. Shuts down a node. For more information, see ShutdownNode on page 92. Removes a license from an application service. For more information, see UnassignLicense on page 93. Disassociates a repository from a Web Services Hub Service in a domain. For more information, see UnassignRSWSHubService on page 95. Disassociates a node from its address. For more information, see UnassociateDomainNode on page 97. Updates the password for the domain administrator. For more information, see UpdateDomainPassword on page 99. Updates the gateway node connectivity information. For more information, see UpdateGatewayInfo on page 100. Updates the list of nodes assigned to a grid. For more information, see UpdateGrid on page 101. Updates the configuration properties for the Integration Service. For more information, see UpdateIntegrationService on page 102. Updates license information for a domain. For more information, see UpdateLicense on page 104. Updates gateway node information for a domain. For more information, see UpdateNodeOptions on page 105. Updates the service options for the Repository Service. For more information, see UpdateRepositoryService on page 107. Updates the service process. For more information, see UpdateServiceProcess on page 109. Updates the service options for the Web Services Hub Service. For more information, see UpdateWSHubService on page 111.
24
AddDomainLink
Records connection properties to a remote, or linked, domain so that you can exchange repository metadata between the local domain and the linked domain. You may want to add a link to a domain if you need to access a Repository Service in that domain. For more information about working with multiple domains, see Managing the Domain in the Administrator Guide. To run the AddDomainLink command, you must have permission on the local domain and full privileges in the Administration Console. The AddDomainLink command uses the following syntax:
AddDomainLink <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-linkeddomainname|-ld> name_of_linked_domain <-domainlink|-dl> gateway_host1:port gateway_host2:port ...
Table 3-2 lists infacmd AddDomainLink options and arguments:

Table 3-2. AddDomainLink Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the local domain. User name used to connect to the local domain. Password for the local domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the local domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the local domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
-resiliencetimeout -re
period_in_secs
Optional
AddDomainLink
25
Table 3-2. AddDomainLink Options and Arguments Option -linkeddomainname -ld -domainlink -dl Argument name_of_linked _domain gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Description Name of the domain that you want to establish a connection with. The host names and port numbers for the gateway nodes in the linked domain.
26
AddDomainNode
Adds a node to a domain. Before you can start the node, you must define it by running the infasetup DefineGatewayNode or DefineWorkerNode command on the node. For more information about these commands, see DefineGatewayNode on page 122 and DefineWorkerNode on page 124. To run the AddDomainNode command, you must have permission on the domain and full privileges in the Administration Console. The AddDomainNode command uses the following syntax:
AddDomainNode <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name
Table 3-3 lists infacmd AddDomainNode options and arguments:

Table 3-3. AddDomainNode Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node you want to add to the domain.
period_in_secs
Optional
-nodename -nn
node_name
Required
AddDomainNode
27
AddLicense
Adds a license to a domain. After you add the license, you can assign it to an application service using the AssignLicense command. You must assign a license to a service before you can use the service. To run the AddLicense command, you must have full privileges in the Administration Console and permission on the domain or folder where you want to add the license. The AddLicense command uses the following syntax:
AddLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license <-licensekeyfile|-lf> license_key_file
Table 3-4 lists infacmd AddLicense options and arguments:

Table 3-4. AddLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
28
Table 3-4. AddLicense Options and Arguments Option -licensename -ln Argument name_of_license Required/ Optional Required Description Name of the license. The name is not case sensitive and must be unique within the domain. The name cannot have leading or trailing spaces, include carriage returns or tabs, exceed 79 characters, or contain the following characters: /*?<>"| Path to the license key file.
-licensekeyfile -lf
license_key_file
Required
AddLicense
29
AddNodeResource
Adds a custom or file/directory resource to a node. When an Integration Service runs on a grid, the Load Balancer uses resources to distribute Session and Command tasks. The Load Balancer distributes tasks to nodes where the required resources are available. To run the AddNodeResource command, you must have permission on the node and full privileges in the Administration Console. The AddNodeResource command uses the following syntax:
AddNodeResource <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name <-resourcetype|-rt> resource_type("Custom", "File Directory") <-resourcename|-rn> resource_name
Table 3-5 lists infacmd AddNodeResource options and arguments:

Table 3-5. AddNodeResource Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node where you want to add a resource.
period_in_secs
Optional
-nodename -nn
node_name
Required
30
Table 3-5. AddNodeResource Options and Arguments Option -resourcetype -rt Argument resource_type Required/ Optional Required Description Type of resource. Valid types include: - Custom - File Directory To specify a file directory resource, enter file directory in quotation marks. For more information about resource types, see Managing the Grid in the Administrator Guide. Name of the resource. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. The name cannot have leading or trailing spaces, include carriage returns or tabs, exceed 79 characters, or contain the following characters: \/*?<>"|$
-resourcename -rn
resource_name
Required
AddNodeResource
31
AssignedToLicense
Lists the services assigned to a license. The AssignedToLicense command uses the following syntax:
AssignedToLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license
Table 3-6 lists infacmd AssignedToLicense options and arguments:

Table 3-6. AssignedToLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the license.
period_in_secs
Optional
-licensename -ln
name_of_license
Required
32
AssignLicense
Assigns a license to an application service. You must assign a license to an application service before you can enable the service.
Note: You cannot assign a license to a service if the service is already assigned to another
license. To assign a different license to a service, remove the existing license from the service, and then assign the new license to the service. To run the AssignLicense command, you must have full privileges in the Administration Console and permission on the license. The AssignLicense command uses the following syntax:
AssignLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license <-servicenames|-sn> name_of_service1 name_of_service2 ...
Table 3-7 lists infacmd AssignLicense options and arguments:

Table 3-7. AssignLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
AssignLicense
33
Table 3-7. AssignLicense Options and Arguments Option -licensename -ln -servicenames -sn Argument name_of_license name_of_service1 name_of_service2 ... Required/ Optional Required Required Description Name of the license you want to assign to a service. Names of the services for which you want to assign a license. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
34
AssignRSToWSHubService
Associates a repository with a Web Services Hub Service in a domain. To run the AssignRSToWSHubService command, you must have permission on the Web Services Hub Service and full privileges in the Administration Console. The AssignRSToWSHubService command uses the following syntax:
AssignRSToWSHubService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-repositoryservice|-rs> repository_service_name <-repositorydomain|-rd> domain_of_repository <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password
Table 3-8 lists infacmd AssignRSToWSHubService options and arguments:

Table 3-8. AssignRSToWSHubService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
AssignRSToWSHubService
35
Table 3-8. AssignRSToWSHubService Options and Arguments Option -servicename -sn -nodename -nn Argument name_of_service node_name Required/ Optional Required Required Description Name of the Web Services Hub Service with which you want to associate a repository. Name of the node where you want the Web Services Hub Service process to run. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. Name of the Repository Service that the Web Services Hub Service depends on. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
-repositoryservice -rs
repository_service_name
Required
-repositorydomain -rd
domain_of_repository
Required
-repositoryuser -ru
repository_user
Required
-repositorypwd -rp
repository_password
Required
36
ConvertLogFile
Converts binary log files to text files, XML files, or readable text on the screen. The ConvertLogFile command uses the following syntax:
ConvertLogFile <-inputlocation|-in> input_file_location [<-format|-fm> format_TEXT_XML] [<-location|-lo> output_file_location]
Table 3-9 lists infacmd ConvertLogFile options and arguments:

Table 3-9. ConvertLogFile Options and Arguments Option -inputlocation -in Argument input_file_location Required/ Optional Required Description Name and path for the log file you want to convert. By default, the Service Manager writes log files to the server\infa_shared\log directory on the master gateway node. Log file format. Valid types include: - Text - XML If you do not specify a format, infacmd displays the log events in text format with lines wrapped at 80 characters. Name and file path for the output file. If you do not specify an output file location, infacmd displays the log events on the screen.
-format -fm
format
Optional
-location -lo
output_file_location
Optional
ConvertLogFile
37
CreateGrid
Creates a grid in a domain and assigns nodes to the grid. For more information about creating grids, see Managing the Grid in the Administrator Guide. To run the CreateGrid command, you must have full privileges in the Administration Console and permission on the domain. The CreateGrid command uses the following syntax:
CreateGrid <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-gridname|-gn> grid_name <nodelist|-nl node1 node2 ...>
Table 3-10 lists infacmd CreateGrid options and arguments:

Table 3-10. CreateGrid Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the grid. Names of the nodes you want to assign to the grid.
period_in_secs
Optional
-gridname -gn -nodelist -nl
grid_name node1 node2 ...
Required Required
38
CreateIntegrationService
Creates an Integration Service in a domain. The Integration Service is disabled when you create it unless you specify the Codepage_ID service process option. If the service is disabled, you must enable it before you can use it. To run the CreateIntegrationService command, you must have full privileges in the Administration Console and permission on the domain. The CreateIntegrationService command uses the following syntax:
CreateIntegrationService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <<-nodename|-nn> node_name|<-gridname|-gn> grid_name> [<-backupnodes|-bn> node1 node2 ...] <-repositoryservice|-rs> repository_service_name [<-repositorydomain|-rd> domain_of_repository] <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password [<-serviceoptions|-so> option_name=value ...] [<-serviceprocessoptions|-po> option_name=value ...] [<-licensename|-ln> name_of_license]
Table 3-11 lists infacmd CreateIntegrationService options and arguments:

Table 3-11. CreateIntegrationService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide.
39
Table 3-11. CreateIntegrationService Options and Arguments Option -resiliencetimeout -re Argument period_in_secs Required/ Optional Optional Description Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the Integration Service. The name is not case sensitive and must be unique within the domain. The characters must be compatible with the code page of the associated repository. The name cannot have leading or trailing spaces, include carriage returns or tabs, exceed 79 characters, or contain the following characters: /*?<>"| Name of the node where you want the Integration Service process to run. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. Required if you do not specify the grid name. Name of the grid where you want the Integration Service process to run. Required if you do not specify the node name. If the PowerCenter environment is configured for high availability, this option specifies the names of the backup nodes. Name of the Repository Service that the Integration Service depends on. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
-servicename -sn
name_of_service
Required
-nodename -nn
node_name
Conditional
-gridname -gn
grid_name
Conditional
-backupnodes -bn -repositoryservice -rs
node1 node2 ...
Optional
Required
Conditional
-repositoryuser -ru
repository_user
Required
40
Table 3-11. CreateIntegrationService Options and Arguments Option -repositorypwd -rp Argument repository_password Required/ Optional Required Description Repository user password. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Service properties that define how the Integration Service runs. For more information about Integration Service options, see Integration Service Options on page 41. Service process properties for the Integration Service. In a grid or multi-node environment, infacmd applies these properties to the primary node. infacmd populates the other nodes with default values. For more information about service process options, see Service Process Options on page 44. Name of the license you want to assign to the Integration Service.
-serviceoptions -so
option_name=value
Optional
-serviceprocessoptions -po
option_name=value
Optional
-licensename -ln
name_of_license
Optional
Integration Service Options

Enter Integration Service options in the following format:
infacmd CreateIntegrationService ... -so option_name=value option_name=value ...
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation marks. For more information about Integration Service options, see Creating and Configuring the Integration Service in the Administrator Guide. Table 3-12 lists Integration Service options:
Table 3-12. Integration Service Options Option DataMovementMode Required/ Optional Optional Description Mode that determines how the Integration Service handles character data: - ASCII - Unicode Default is ASCII. If you do not enter a value for this option, infacmd uses the default value. Email address of the user to receive email when a session fails to complete.
$PMFailureEmailUser
Optional
41
Table 3-12. Integration Service Options Option $PMSuccessEmailUser $PMSessionLogCount $PMWorkflowLogCount $PMSessionErrorThreshold Required/ Optional Optional Optional Optional Optional Description Email address of the user to receive email when a session completes successfully. Number of session logs the Integration Service archives for the session. Minimum value is 0. Default is 0. Number of workflow logs the Integration Service archives for the workflow. Minimum value is 0. Default is 0. Number of non-fatal errors the Integration Service allows before failing the session. Default is 0 (non-fatal errors do not cause the session to stop). Appends a timestamp to messages written to the workflow log. Default is No. Handles Aggregator transformations as the PowerMart Server did in PowerMart 3.5. Default is No. Processes master and detail pipelines sequentially as in PowerCenter versions prior to 7.0. Default is No. Treats nulls as zero in Aggregator transformations. Default is No. Performs aggregate calculations before flagging records for insert, update, delete, or reject in Update Strategy expressions. Default is No. Handles dates as in PowerCenter 1.0/PowerMart 4.0. Default is No. Keeps trailing spaces when reading SAP or PeopleSoft CHAR data. Default is Yes. Maximum number of connections to a lookup or stored procedure database when you start a session. Minimum value is 0. Default is 0. Maximum number of connections to a Sybase database when you start a session. Minimum value is 100. Maximum value is 2,147,483,647. Default is 100. Maximum number of connections to a Microsoft SQL Server database when you start a session. Minimum value is 100. Maximum value is 2,147,483,647. Default is 100. Number of times the Integration Service retries writing to a target on a database deadlock. Minimum value is 0. Maximum value is 2,147,483,647. Default is 10. Number of seconds before the Integration Service retries writing to a target on database deadlock. Minimum value is 0. Maximum value is 2,147,483,647. Default is 0 (retry the target write immediately).
TimestampWorkflowLogMessages Pmserver3XCompatibility JoinerSourceOrder6xCompatibility AggregateTreatNullAsZero AggregateTreatRowAsInsert
Optional Optional Optional Optional Optional
DateHandling40Compatibility TreatCharAsCharOnRead MaxLookupSPDBConnections
Optional Optional Optional
MaxSybaseConnections
Optional
MaxMSSQLConnections
Optional
NumOfDeadlockRetries
Optional
DeadlockSleep
Optional
42
Table 3-12. Integration Service Options Option XMLWarnDupRows CreateIndicatorFiles OutputMetaDataForFF TreatDBPartitionAsPassThrough ExportSessionLogLibName TreatNullInComparisonOperators As Required/ Optional Optional Optional Optional Optional Optional Optional Description Writes duplicate row warnings and duplicate rows for XML targets to the session log. Default is Yes. Creates indicator files when you run a workflow with a flat file target. Default is No. Writes column headers to flat file targets. Default is No. Uses pass-through partitioning for non-DB2 targets when the partition type is Database Partitioning. Default is No. Name of an external library file to write session log messages. Determines how the Integration Service evaluates null values in comparison operations: - Null - Low - High Default is Null. If you do not enter a value for this option, infacmd uses the default value. In target-based commit mode, the amount of time in seconds the writer remains idle before it issues a commit. Minimum value is 60. Maximum value is 2,147,483,647. Default is 60. Microsoft Exchange profile used by the Service Start Account to send post-session email. Date format the Integration Service uses in log entries. Default is DY MON DD HH 24:MI:SS YYYY. Allows you to use this Integration Service to run debugger sessions from the Designer. Default is Yes. Minimum level of error logging for the Integration Service logs: - fatal - error - warning - info - trace - debug Default is info. If you do not enter a value for this option, infacmd uses the default value. Appends a timestamp to messages written to the workflow log. Default is No. Enforces data code page compatibility. Default is Yes. Ignores task resource requirements when distributing tasks across the nodes of a grid. Default is Yes. Writes all logs using the UTF-8 character set. Default is Yes (Unicode) or No (ASCII).
WriterWaitTimeOut
Optional
MSExchangeProfile DateDisplayFormat LoadManagerAllowDebugging ErrorSeverityLevel
Optional Optional Optional Optional
TimeStampLog ValidateDataCodePages IgnoreResourceRequirements LogsInUTF8
43
Table 3-12. Integration Service Options Option TrustStore Required/ Optional Optional Description Enter the value for TrustStore using the following syntax:
<path>/<filename>
For example:
./Certs/trust.keystore
ClientStore
Optional
Enter the value for ClientStore using the following syntax:

<path>/<filename>
For example:
./Certs/client.keystore
JCEProvider
Optional
JCEProvider class name to support NTLM authentication. For example:

com.unix.crypto.provider.UnixJCE.
HttpProxyServer HttpProxyPort HttpProxyUser HttpProxyPassword HttpProxyDomain
Name of the HTTP proxy server. Port number of the HTTP proxy server. Authenticated user name for the HTTP proxy server. Required if the proxy server requires authentication. Password for the authenticated user. Required if the proxy server requires authentication. Domain for authentication.
Service Process Options

Enter service process options in the following format:
infacmd CreateIntegrationService ... -po option_name=value option_name=value ...
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation marks. For more information about service process options, see Creating and Configuring the Integration Service in the Administrator Guide. Table 3-13 lists service process options:
Table 3-13. Integration Service Process Options Option Codepage_ID Required/ Optional Required Description Code page ID number for the Integration Service process. For more information about code page ID numbers, see Code Pages in the Administrator Guide. Root directory accessible by the node. Default is C:\Informatica\PowerCenter8.1\server\infa_shared. If you do not enter a value for this option, infacmd uses the default value.
$PMRootDir
Optional
44
Table 3-13. Integration Service Process Options Option $PMSessionLogDir $PMBadFileDir $PMCacheDir Required/ Optional Optional Optional Optional Description Default directory for session logs. Default is $PMRootDir/SessLogs. If you do not enter a value for this option, infacmd uses the default value. Default directory for reject files. Default is $PMRootDir/BadFiles. If you do not enter a value for this option, infacmd uses the default value. Default directory for index and data cache files. Default is $PMRootDir/ Cache. If you do not enter a value for this option, infacmd uses the default value. Default directory for target files. Default is $PMRootDir/TgtFiles. If you do not enter a value for this option, infacmd uses the default value. Default directory for source files. Default is $PMRootDir/SrcFiles. If you do not enter a value for this option, infacmd uses the default value. Default directory for external procedures. Default is $PMRootDir/ExtProc. If you do not enter a value for this option, infacmd uses the default value. Default directory for temporary files. Default is $PMRootDir/Temp. If you do not enter a value for this option, infacmd uses the default value. Default directory for workflow logs. Default is $PMRootDir/WorkflowLogs. If you do not enter a value for this option, infacmd uses the default value. Default directory for lookup files. Default is $PMRootDir/LkpFiles. If you do not enter a value for this option, infacmd uses the default value. Default directory for run-time files. Default is $PMRootDir/Storage. If you do not enter a value for this option, infacmd uses the default value. Java SDK classpath. Minimum amount of memory the Java SDK uses during a PowerCenter session. Default is 32 MB. Maximum amount of memory the Java SDK uses during a PowerCenter session. Default is 64 MB.
$PMTargetFileDir $PMSourceFileDir $PMExtProcDir $PMTempDir $PMWorkflowLogDir $PMLookupFileDir $PMStorageDir JVMClassPath JVMMinMemory JVMMaxMemory
Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional
45
CreateRepositoryService
Creates a Repository Service in a domain. By default, the Repository Service is disabled when you create it. You must enable the service before you can use it. A Repository Service manages one repository. It performs all metadata transactions between the repository and repository client applications. To run the CreateRepositoryService command, you must have full privileges in the Administration Console and permission on the domain. The CreateRepositoryService command uses the following syntax:
CreateRepositoryService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name [<-backupnodes|-bn> node1 node2 ...] <-serviceoptions|-so> option_name=value ... [<-licensename|-ln> name_of_license]
Table 3-14 lists infacmd CreateRepositoryService options and arguments:

Table 3-14. CreateRepositoryService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
46
Table 3-14. CreateRepositoryService Options and Arguments Option -servicename -sn Argument name_of_service Required/ Optional Required Description Name of the Repository Service. The name is not case sensitive and must be unique within the domain. The characters must be compatible with the code page of the associated repository. The name cannot have leading or trailing spaces, include carriage returns or tabs, exceed 79 characters, or contain the following characters: \/:*?<>"| Name of the node where you want the Repository Service process to run. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. If the PowerCenter environment is configured for high availability, this option specifies the names of the backup nodes. Service properties that define how the Repository Service runs. For more information about Repository Service options, see Repository Service Options on page 47. Name of the license you want to assign to the Repository Service.
-nodename -nn
node_name
Required
-backupnodes -bn -serviceoptions -so
node1 node2 ...
Optional
option_name=value
Required
-licensename -ln
name_of_license
Optional
Repository Service Options

Enter Repository Service options in the following format:
infacmd CreateRepositoryService ... -so option_name=value option_name=value ...
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation marks. For more information about Repository Service options, see Managing the Repository in the Administrator Guide. Table 3-15 lists Repository Service options:
Table 3-15. Repository Service Options Option DatabaseType CodePage Required/ Optional Required Required Description Type of database that stores the repository metadata. Code page for the database. To enter a code page string that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
47
Table 3-15. Repository Service Options Option ConnectString TablespaceName DBUser DBPassword OperatingMode Required/ Optional Required Optional Required Required Optional Description Database connection string specified during Repository Service setup. Tablespace name for IBM DB2 repositories. Account for the database containing the repository. Repository database password corresponding to the database user. Mode in which the Repository Service is running: - Normal - Exclusive Default is Normal. If you do not enter a value for this option, infacmd uses the default value. Tracks changes made to users, groups, privileges, and permissions. Default is No. If you do not enter a value for this option, infacmd uses the default value. Uses Windows authentication to access the Microsoft SQL Server database. Requires users to add comments when checking in repository objects. Minimum level of error messages written to the Repository Service log: - Fatal - Error - Warning - Info - Trace - Debug Default is Info. If you do not enter a value for this option, infacmd uses the default value. Maximum amount of time, in seconds, that the service holds on to resources for resilience purposes. Default is 180. Amount of time, in seconds, that the service tries to establish or reestablish a connection to another service. Default is 180. Amount of time, in seconds, that the Repository Service attempts to establish a connection to the database management system. Default is 180. Interval at which the Repository Service verifies its connections with clients of the service. Default is 60 seconds. Number of rows to fetch each time an array database operation is issued, such as insert or fetch. Default is 100. Maximum number of connections the repository accepts from repository client applications. Default is 200.
SecurityAuditTrail
Optional
TrustedConnection CheckinCommentsRequired ErrorSeverityLevel
MaxResilienceTimeout ServiceResilienceTimeout DatabaseConnectionTimeout
HeartBeatInterval DatabaseArrayOperationSize MaximumConnections
48
Table 3-15. Repository Service Options Option MaximumLocks DatabasePoolSize EnableRepAgentCaching RACacheCapacity AllowWritesWithRACaching DBPoolExpiryTimeout Required/ Optional Optional Optional Optional Optional Optional Optional Description Maximum number of locks the repository places on metadata objects. Default is 50,000. Maximum number of connections to the repository database that the Repository Service can establish. Minimum is 20. Default is 500. Enables the repository agent caching feature. Default is Yes. Number of objects that the cache can contain when repository agent caching is enabled. Default is 10,000. Uses PowerCenter Client tools to modify metadata in the repository when repagent caching is enabled. Default is Yes. The interval, in seconds, at which the Repository Service checks for idle database connections. If a connection is idle for a period of time greater than this value, the Repository Service can close the connection. Minimum is 300. Maximum is 2,592,000 (30 days). Default is 3,600 (1 hour). The minimum number of idle database connections allowed by the Repository Service. For example, if there are 20 idle connections, and you set this threshold to 5, the Repository Service closes no more than 15 connections. Minimum is 3. Default is 5.
DBPoolExpiryThreshold
Optional
49
CreateWSHubService
Creates a Web Services Hub Service in a domain. By default, the Web Services Hub Service is disabled when you create it. You must enable the service before you can use it. For more information about Web Services Hub Services, see the Web Services Provider Guide. To run the CreateWSHubService command, you must have full privileges in the Administration Console and permission on the domain. The CreateWSHubService command uses the following syntax:
CreateWSHubService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-repositoryservice|-rs> repository_service_name <-repositorydomain|-rd> domain_of_repository <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password [<-serviceoptions|-so> option_name=value ...] [<-licensename|-ln> name_of_license]
Table 3-16 lists infacmd CreateWSHubService options and arguments:

Table 3-16. CreateWSHubService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
50
Table 3-16. CreateWSHubService Options and Arguments Option -servicename -sn Argument name_of_service Required/ Optional Required Description Name of the Web Services Hub Service you want to create. The name is not case sensitive and must be unique within the domain. The characters must be compatible with the code page of the associated repository. The name cannot have leading or trailing spaces, include carriage returns or tabs, exceed 79 characters, or contain the following characters: /*?<>"| Name of the node where you want to run the Web Services Hub Service process. Name of the Repository Service that the Web Services Hub Service depends on. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Service properties that define how the Web Services Hub Service runs. For more information about Web Services Hub Service options, see Web Services Hub Service Options on page 51. Name of the license you want to assign to the Web Services Hub Service.
-nodename -nn -repositoryservice -rs
node_name repository_service_ name
Required Required
domain_of_ repository
Conditional
-repositoryuser -ru
repository_user
Required
-repositorypwd -rp
repository_password
Required
-serviceoptions -so
option_name=value ...
Optional
-licensename -ln
name_of_license
Optional
Web Services Hub Service Options

Enter Web Services Hub Service options in the following format:
infacmd CreateWSHubService ... -so option_name=value option_name=value ...
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation marks.
CreateWSHubService 51
For more information about Web Services Hub Service options, see Installing and Configuring Web Services Hub in the Web Services Provider Guide. Table 3-17 lists Web Services Hub Service options:
Table 3-17. Web Services Hub Service Options Option WSH_ENCODING InternalHostName InternalPortNumber URLScheme HubHostName HubPortNumber DTMTimeout ErrorSeverityLevel Required/ Optional Optional Optional Optional Optional Optional Optional Optional Optional Description Character encoding for the Web Services Hub. Default is UTF-8. Host name at which the Web Services Hub Service listens for connections from the Integration Service. Default is localhost. Port number at which the Web Services Hub Service listens for connections from the Integration Service. Default is 15555. Security protocol that you configure for the Web Services Hub: HTTP or HTTPS. Default is HTTP. Name of the machine hosting the Web Services Hub. Default is localhost. Port number on which the Web Services Hub runs in Tomcat. Default is 7333. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the DTM. Default is 60. Minimum level of error logging for the Web Services Hub Service logs: - Fatal - Error - Warning - Info - Trace - Debug Default is Info. If you do not enter a value for this option, infacmd uses the default value.
52
DisableNodeResource
Disables a PowerCenter resource. You can disable file/directory, custom, and connection resources. When an Integration Service runs on a grid, the Load Balancer uses resources to distribute Session and Command tasks. The Load Balancer distributes tasks that require PowerCenter resources to nodes where the resources are added and enabled. By default, all connection resources are enabled on a node. Disable the resources that are not available to prevent the Load Balancer from dispatching a task to a node that does not have the required resources. To run the DisableNodeResource command, you must have permission on the node and full privileges in the Administration Console. The DisableNodeResource command uses the following syntax:
DisableNodeResource <-domainname|-dn> name_of_domain] <-username|-un> name_of_user] <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name <-resourcetype|-rt> resource_type("Custom", "File Directory", "Connection") <-resourcename|-rn> resource_name
Table 3-18 lists infacmd DisableNodeResource options and arguments:

Table 3-18. DisableNodeResource Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide.
DisableNodeResource
53
Table 3-18. DisableNodeResource Options and Arguments Option -resiliencetimeout -re Argument period_in_secs Required/ Optional Optional Description Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node where the resource is defined. Type of resource. Valid types include: - Custom - File Directory - Connection To specify a file directory resource, enter file directory in quotation marks. For more information about resource types, see Managing the Grid in the Administrator Guide. Entire name of the resource. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. To list the names of all resources available to a node, run the ListNodeResources command.
-nodename -nn -resourcetype -rt
node_name resource_type
Required Required
-resourcename -rn
resource_name
Required
54
DisableService
Disables the application service corresponding to the service name. Use this command to disable a Repository Service, Integration Service, Web Services Hub, or SAP BW Service. When you disable a service, all service processes stop. To run the DisableService command, you must have permission on the service and full privileges in the Administration Console. The DisableService command uses the following syntax:
DisableService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-mode|-mo> disable_mode
Table 3-19 lists infacmd DisableService options and arguments:

Table 3-19. DisableService Options and Arguments Option -domainname -dn -username -un -password -pd -resiliencetimeout -re Argument name_of_domain name_of_user password period_in_secs Required/ Optional Required Required Required Optional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service you want to disable. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Defines how the service is disabled: - Complete. Disables the service after all service processes stop. - Stop. If the service is an Integration Service, stops all running workflows, and then disables the Integration Service. - Abort. Stops all processes immediately, and then disables the service.
-servicename -sn -mode -mo
name_of_service
Required
disable_mode
Required
DisableService
55
DisableServiceProcess
Disables the service process on a specified node. You can disable a service process on a specified node if the node requires maintenance. To run the DisableServiceProcess command, you must have permission on the service and full privileges in the Administration Console. The DisableServiceProcess command uses the following syntax:
DisableServiceProcess <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-mode|-mo> disable_mode
Table 3-20 lists infacmd DisableServiceProcess options and arguments:

Table 3-20. DisableServiceProcess Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service associated with the process you want to disable. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
56
Table 3-20. DisableServiceProcess Options and Arguments Option -nodename -nn -mode -mo Argument node_name disable_mode Required/ Optional Required Required Description Name of the node where the service process is running. Defines how the service process is disabled: - Complete. Allows the service process to complete the current tasks before disabling. - Abort. Disables the service process before the current task completes.
DisableServiceProcess
57
EnableNodeResource
Enables a PowerCenter resource. You can enable file/directory, custom, and connection resources. When an Integration Service runs on a grid, the Load Balancer uses resources to distribute Session and Command tasks. The Load Balancer distributes tasks that require PowerCenter resources to nodes where the resources are added and enabled. When you enable a resource on a node, you allow the Load Balancer to distribute tasks that require the resource to the node. To run the EnableNodeResource command, you must have permission on the node and full privileges in the Administration Console. The EnableNodeResource command uses the following syntax:
EnableNodeResource <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name <-resourcetype|-rt> resource_type("Custom", "File Directory", "Connection") <-resourcename|-rn> resource_name
Table 3-21 lists infacmd EnableNodeResource options and arguments:

Table 3-21. EnableNodeResource Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
58
Table 3-21. EnableNodeResource Options and Arguments Option -nodename -nn -resourcetype -rt Argument node_name resource_type Required/ Optional Required Required Description Name of the node where the resource is defined. Type of resource. Valid types include: - Custom - File Directory - Connection To specify a file directory resource, enter file directory in quotation marks. For more information about resource types, see Managing the Grid in the Administrator Guide. Entire name of the resource. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. To list the names of all resources available to a node, run the ListNodeResources command.
-resourcename -rn
resource_name
Required
EnableNodeResource
59
EnableService
Enables the application service corresponding to the service name. Use this command to enable a Repository Service, Integration Service, Web Services Hub, or SAP BW Service. To run the EnableService command, you must have permission on the service and full privileges in the Administration Console. The EnableService command uses the following syntax:
EnableService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service
Table 3-22 lists infacmd EnableService options and arguments:

Table 3-22. EnableService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service you want to enable. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
60
EnableServiceProcess
Enables a service process on a specified node. To run the EnableServiceProcess command, you must have permission on the service and full privileges in the Administration Console. The EnableServiceProcess command uses the following syntax:
EnableServiceProcess [<-domainname|-dn> name_of_domain] [<-username|-un> name_of_user] [<-password|-pd> password] [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name
Table 3-23 lists infacmd EnableServiceProcess options and arguments:

Table 3-23. EnableServiceProcess Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service associated with the process you want to enable. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Name of the node where you want to enable a service process.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
-nodename -nn
node_name
Required
EnableServiceProcess
61
GetLastError
Fetches the most recent error messages for an application service running on a node. The error messages are log events that have a severity level of error or fatal. This command does not return errors that occurred before Informatica Services were last started. You can fetch error messages in a file or display them on the screen. The GetLastError command uses the following syntax:
GetLastError <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name [<-format|-fm> format_TEXT_XML] [<-maxevents|-me> max_num_of_error_events]
Table 3-24 lists infacmd GetLastError options and arguments:

Table 3-24. GetLastError Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument domain_name user_name password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service for which you want to fetch error messages. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Optional
62
Table 3-24. GetLastError Options and Arguments Option -nodename -nn -format -fm Argument node_name format Required/ Optional Required Optional Description Name of the node where the service runs. Format for error messages. Valid types include: - Text - XML If you do not specify a format, infacmd displays the messages in text format with lines wrapped at 80 characters. Maximum number of error messages to fetch. Default is 1. Maximum is 20.
-maxevents -me
max_num_of_error_ events
Optional
GetLastError
63
GetLog
Fetches log events based on the criteria you provide. You can fetch log events for a domain, Repository Service, Integration Service, Web Services Hub, or SAP BW Service. You can fetch log events in a file or display them on the screen. To fetch log events for a domain, you must have permission on the domain. To fetch log events for a service, you must have permission on the service. The GetLog command uses the following syntax:
GetLog <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] [<-startdate|-sd> start_date_time] [<-enddate|-ed> end_date_time] [<-reverseorder|-ro>] [<-format|-fm> format_TEXT_XML_BIN] [<-location|-lo> output_file_location] [<-servicetype|-st> service_type_PCSF_IS_RS_WS_BW] [<-servicename|-sn> name_of_service] [<-severity|-svt> severity_level FATAL_ERROR_WARNING_INFO_TRACE_DEBUG]
Table 3-25 lists infacmd GetLog options and arguments:

Table 3-25. GetLog Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument domain_name user_name password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
64
Table 3-25. GetLog Options and Arguments Option -startdate -sd Argument start_date_time Required/ Optional Optional Description Returns log events starting from this date and time. Enter date and time in one of the following formats: - MM/dd/yyyy_hh:mm:ssa_Z - MM/dd/yyyy_hh:mma_Z - MM/dd/yyyy_hh:mm:ssa - MM/dd/yyyy_hh:mma - yyyy-MM-dd_HH:mm:ss_Z - yyyy-MM-dd_HH:mm_Z - yyyy-MM-dd_HH:mm:ss - yyyy-MM-dd_HH:mm - MM/dd/yyyy hh:mm:ssa Z - MM/dd/yyyy hh:mma Z - MM/dd/yyyy hh:mm:ssa - MM/dd/yyyy hh:mma - yyyy-MM-dd HH:mm:ss_Z - yyyy-MM-dd HH:mm_Z - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - MM/dd/yyyy - yyyy-MM-dd where a is an am/pm marker (a for a.m. and p for p.m.) and Z is a time zone marker (for example,0800 or GMT). Returns log events ending by this date and time. Enter date and time in the same format as the startdate option. If you enter an end date that is before the start date, GetLog returns no log events. Fetches log events according to most recent timestamp. Format for log events. Valid types include: - Text - XML - Bin (binary) If you choose binary, then you must specify a file name using the location option. If you do not specify a format, infacmd displays the log events in text format with lines wrapped at 80 characters. Name and file path where you want to write the log file. By default, the Service Manager uses the server\infa_shared\log directory on the master gateway node. Omit this option to display the log events on the screen. If you choose binary as the output file type, you must specify a file name using this option.
-enddate -ed
end_date_time
Optional
-reverseorder -ro -format -fm
n/a format
Optional Optional
-location -lo
output_file_location
Conditional
GetLog
65
Table 3-25. GetLog Options and Arguments Option -servicetype -st Argument service_type Required/ Optional Optional Description Type of service for which you want to fetch log events. You can specify one service type. Omit this option to fetch log events for all service types. Service types include: - PCSF (PowerCenter Services Framework) - IS (Integration Service) - RS (Repository Service) - WS (Web Services Hub) - BW (SAP BW Service) Name of the service for which you want to fetch log events. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Message Severity. Severity types include: - Fatal - Error - Warning - Info - Trace - Debug
-servicename -sn
name_of_service
Optional
-severity -svt
severity_level
Optional
66
GetServiceOption
Fetches the value of a service property for an Integration Service, Repository Service, SAP BW Service, or Web Services Hub Service. For example, you can retrieve the repository database type. The GetServiceOption command uses the following syntax:
GetServiceOption <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-optionname|-op> option_name
Table 3-26 lists infacmd GetServiceOption options and arguments:

Table 3-26. GetServiceOption Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
GetServiceOption
67
Table 3-26. GetServiceOption Options and Arguments Option -servicename -sn Argument name_of_service Required/ Optional Required Description Name of the service for which you want to fetch a value. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the option for which you want to retrieve a value. The options you specify depend on the service type: - For more information about Integration Service options, see Integration Service Options on page 41. - For more information about Repository Service options, see Repository Service Options on page 47. - For a SAP BW Service, specify BWSystemConXString (the SAP Destination R type) or RetryPeriod (the retry period in seconds). - For more information about Web Services Hub Service options, see Web Services Hub Service Options on page 51.
-optionname -op
option_name
Required
68
GetServiceProcessOption
Returns the value of an Integration Service process property running on a node. The GetServiceProcessOption command uses the following syntax:
GetServiceProcessOption <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-optionname|-op> option_name
Table 3-27 lists infacmd GetServiceProcessOption options and arguments:

Table 3-27. GetServiceProcessOption Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service for which you want to fetch a value. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the node where the service process is running. Name of the option for which you want to retrieve a value. For more information, see Service Process Options on page 44.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
-nodename -nn -optionname -op
node_name option_name
Required Required
GetServiceProcessOption
69
GetServiceProcessStatus
Returns the status of an application service process on a node. You can fetch the status of a Repository Service process, Integration Service process, Web Services Hub process, or SAP BW Service process on a node. A service process can be enabled or disabled. The GetServiceProcessStatus command uses the following syntax:
GetServiceProcessStatus <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name
Table 3-28 lists infacmd GetServiceProcessStatus options and arguments:

Table 3-28. GetServiceProcessStatus Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service running the process for which you want the status. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Name of the node where the service process is running.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
-nodename -nn
node_name
Required
70
GetServiceStatus
Returns the status of an application service. You can fetch the status of a Repository Service, Integration Service, Web Services Hub, or SAP BW Service. A service can be enabled or disabled. The GetServiceStatus command uses the following syntax:
GetServiceStatus <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service
Table 3-29 lists infacmd GetServiceStatus options and arguments:

Table 3-29. GetServiceStatus Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service for which you want the status. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
GetServiceStatus
71
GetSessionLog
Fetches log events for the most recent run of a session.
Note: The Repository Service must be running when you run this command.
The GetSessionLog command uses the following syntax:

GetSessionLog <-domainname|-dn> name_of_domain [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] [<-format|-fm> format_TEXT_XML_BIN] [<-location|-lo> output_file_location] <-integrationservice|-is> integration_service_name <-repositoryservice|-rs> repository_service_name [<-repositorydomain|-rd> domain_of_repository] <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password <-foldername|-fn> repository_folder_name <-workflow|-wf> workflow_name <-session|-ss> session_name
Table 3-30 lists infacmd GetSessionLog options and arguments:

Table 3-30. GetSessionLog Options and Arguments Option -domainname -dn -gateway -hp Argument domain_name gateway_host1:port gateway_host2:port ... Required/ Optional Required Conditional Description Name of the domain. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Format for the session log. Valid types include: - Text - XML - Bin (binary) If you choose binary, then you must specify a file name using the location option. If you do not specify a format, infacmd displays the log events in text format with lines wrapped at 80 characters.
period_in_secs
Optional
-format -fm
format
Optional
72
Table 3-30. GetSessionLog Options and Arguments Option -location -lo Argument output_file_location Required/ Optional Conditional Description Name and file path for the session log file. By default, the Service Manager uses the server\infa_shared\log directory on the master gateway node. Omit this option to display the log events on the screen. If you choose binary as the output file type, you must specify a file name using this option. Name of the Integration Service that runs the session. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the Repository Service that contains the session. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the folder containing the session. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the workflow containing the session. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Session name. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.
-integrationservice -is
integration_service_ name
Required
repository_service_ name
Required
Conditional
-repositoryuser -ru
repository_user
Required
-repositorypwd -rp
repository_password
Required
-foldername -fn
repository_folder_nam e
Required
-workflow -wf
workflow_name
Required
-session -ss
session_name
Required
GetSessionLog
73
GetWorkflowLog
Fetches log events for the most recent run of a workflow.
Note: The Repository Service must be running when you run this command.
The GetWorkflowLog command uses the following syntax:

GetWorkflowLog <-domainname|-dn> name_of_domain [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] [<-format|-fm> format_TEXT_XML_BIN] [<-location|-lo> output_file_location] <-integrationservice|-is> integration_service_name <-repositoryservice|-rs> repository_service_name [<-repositorydomain|-rd> domain_of_repository] <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password <-foldername|-fn> repository_folder_name <-workflow|-wf> workflow_name
Table 3-31 lists infacmd GetWorkflowLog options and arguments:

Table 3-31. GetWorkflowLog Options and Arguments Option -domainname -dn -gateway -hp Argument domain_name gateway_host1:port gateway_host2:port ... Required/ Optional Required Conditional Description Name of the domain. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Format for the session log. Valid types include: - Text - XML - Bin (binary) If you choose binary, then you must specify a file name using the location option. If you do not specify a format, infacmd displays the log events in text format with lines wrapped at 80 characters.
period_in_secs
Optional
-format -fm
format
Optional
74
Table 3-31. GetWorkflowLog Options and Arguments Option -location -lo Argument output_file_location Required/ Optional Conditional Description Name and file path for the workflow log file. By default, the Service Manager uses the server\infa_shared\log directory on the master gateway node. Omit this option to display the log events on the screen. If you choose binary as the output file type, you must specify a file name using this option. Name of the Integration Service that runs the workflow. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the Repository Service that contains the workflow. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the folder containing the workflow. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the workflow. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.
-integrationservice -is
integration_service_ name
Required
Required
Conditional
-repositoryuser -ru
repository_user
Required
-repositorypwd -rp
repository_password
Required
-foldername -fn
repository_folder_nam e
Required
-workflow -wf
workflow_name
Required
GetWorkflowLog
75
Help
The Help command displays the options and arguments for a command. If you omit the command name, infacmd lists all commands. The Help command uses the following syntax:
Help [command]
For example, if you type infacmd Help GetServiceStatus, infacmd returns the following options and arguments for the GetServiceStatus command:
Usage: GetServiceStatus <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service
Table 3-32 lists infacmd Help option and argument:

Table 3-32. Help Option and Argument Option n/a Argument command Required/ Optional Optional Description Name of command. If you omit the command name, infacmd lists all commands.
76
ListDomainLinks
Lists the domains that the local domain can connect to. You establish links between two domains so that you can exchange repository metadata between them. For more information about working with multiple domains, see Managing the Domain in the Administrator Guide. The ListDomainLinks command uses the following syntax:
ListDomainLinks <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs]
Table 3-33 lists infacmd ListDomainLinks options and arguments:

Table 3-33. ListDomainLinks Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the local domain. User name used to connect to the local domain. Password for the local domain user name. The host names and port numbers for the gateway nodes in the local domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the local domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
ListDomainLinks
77
ListGridNodes
Lists the nodes assigned to a grid. To run the ListGridNodes command, you must have permission on the grid. The ListGridNodes command uses the following syntax:
ListGridNodes <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-gridname|-gn> grid_name
Table 3-34 lists infacmd ListGridNodes options and arguments:

Table 3-34. ListGridNodes Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the grid.
period_in_secs
Optional
-gridname -gn
grid_name
Required
78
ListLicenses
Lists the licenses in a domain. For each license, infacmd displays the license name and serial number. The ListLicenses command uses the following syntax:
ListLicenses <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs]
Table 3-35 lists infacmd ListLicenses options and arguments:

Table 3-35. ListLicenses Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
ListLicenses
79
ListNodeResources
Lists all PowerCenter resources defined for a node. For each resource, this command returns the resource type and whether the resource is available. To run the ListNodeResources command, you must have permission on the node. The ListNodeResources command uses the following syntax:
ListNodeResources <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name
Table 3-36 lists infacmd ListNodeResources options and arguments:

Table 3-36. ListNodeResources Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node for which you want to list the resources.
period_in_secs
Optional
-nodename -nn
node_name
Required
80
Ping
Pings a domain, service, domain gateway host, or node. If the object is available, infacmd displays a message saying that the object is alive at a specific port on the gateway host machine. If the object is unavailable, infacmd displays a message saying that it failed to receive a response from the object. The Ping command does not display results for individual service processes. Use this command to troubleshoot network connections. To run the Ping command, you must have permission on the object you want to ping. The Ping command uses the following syntax:
Ping [<-domainname|-dn> name_of_domain] [<-servicename|-sn> name_of_service] [<-gatewayaddress|-dg> domain_gateway_host:port] [<-nodename|-nn> node_name] [<-resiliencetimeout|-re> period_in_secs]
Table 3-37 lists infacmd Ping options and arguments:

Table 3-37. Ping Options and Arguments Option -domainname -dn -servicename -sn -gatewayaddress -dg -nodename -nn -resiliencetimeout -re Argument name_of_domain Required/ Optional Conditional Description Name of the domain. Required if you do not specify the gateway host machine name and port number. Name of the service you want to ping. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Gateway host machine name and port number. Required if you do not specify the domain name. Name of the node. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
name_of_service
Optional
domain_gateway_host :port node_name period_in_secs
Conditional Optional Optional
Ping
81
PurgeLog
Purges log events based on criteria you provide. You can purge log events for a domain, Repository Service, Integration Service, Web Services Hub, or SAP BW Service. To purge log events for a domain, you must have permission on the domain. To purge log events for a service, you must have permission on the service. You must also have full privileges in the Administration Console. The PurgeLog command uses the following syntax:
PurgeLog <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-beforedate|-bd> before_date
Table 3-38 lists infacmd PurgeLog options and arguments:

Table 3-38. PurgeLog Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Purges log events that occurred before this date and time. Enter date and time in one of the following formats: - MM/dd/yyyy - yyyy-MM-dd
period_in_secs
Optional
-beforedate -bd
before_date
Required
82
RemoveDomainLink
Removes connection information for the linked domain so that you can no longer exchange repository metadata between the local and linked domains. You may want to do this if you no longer need to access a Repository Service in another PowerCenter domain. For more information about working with multiple domains, see Managing the Domain in the Administrator Guide. To run the RemoveDomainLink command, you must have permission on the local domain and full privileges in the Administration Console. The RemoveDomainLink command uses the following syntax:
RemoveDomainLink <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-linkeddomainname|-ld> name_of_linked_domain
Table 3-39 lists infacmd RemoveDomainLink options and arguments:

Table 3-39. RemoveDomainLink Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the local domain. User name used to connect to the local domain. Password for the local domain user name. The host names and port numbers for the gateway nodes in the local domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the local domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_ RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the domain from which you want to remove a connection.
period_in_secs
Optional
-linkeddomainname -ld
name_of_linked _domain
Required
RemoveDomainLink
83
RemoveGrid
Removes a grid from a domain. To run the RemoveGrid command, you must have full privileges in the Administration Console and permission on the domain or folder that contains the grid. The RemoveGrid command uses the following syntax:
RemoveGrid <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-gridname|-gn> grid_name
Table 3-40 lists infacmd RemoveGrid options and arguments:

Table 3-40. RemoveGrid Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the grid you want to remove.
period_in_secs
Optional
-gridname -gn
grid_name
Required
84
RemoveLicense
Removes a license from a domain. You remove a license from a domain when it expires or when you want to move the license to another domain. Before you run this command, you must first disable the services assigned to the license and then remove the license from the services. For more information about disabling a service, see DisableService on page 55. For more information about removing a license from a service, seeUnassignLicense on page 93. To run the RemoveLicense command, you must have full privileges in the Administration Console, permission on the license, and permission on the domain or folder that contains the license. The RemoveLicense command uses the following syntax:
RemoveLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license
Table 3-41 lists infacmd RemoveLicense options and arguments:

Table 3-41. RemoveLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide.
RemoveLicense
85
Table 3-41. RemoveLicense Options and Arguments Option -resiliencetimeout -re Argument period_in_secs Required/ Optional Optional Description Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the license you want to remove.
-licensename -ln
name_of_license
Required
86
RemoveNode
Removes a node from a domain. If the node is running, you must shut it down before you can remove it. To run the RemoveNode command, you must have full privileges in the Administration Console, permission on the node, and permission on the domain or folder that contains the node. The RemoveNode command uses the following syntax:
RemoveNode <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name
Table 3-42 lists infacmd RemoveNode options and arguments:

Table 3-42. RemoveNode Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node you want to remove.
period_in_secs
Optional
-nodename -nn
node_name
Required
RemoveNode
87
RemoveNodeResource
Removes a resource from a node. When an Integration Service runs on a grid, the Load Balancer uses resources to distribute Session and Command tasks. The Load Balancer distributes tasks that require PowerCenter resources to nodes where the resources are added and enabled. If you remove a resource that is required by the Session or Command task, the task can no longer run on that node. You can remove a custom or file/directory resource from a node. You cannot remove a connection resource from a node. To run the RemoveNodeResource command, you must have permission on the node and full privileges in the Administration Console. The RemoveNodeResource command uses the following syntax:
RemoveNodeResource <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password] [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name <-resourcetype|-rt> resource_type("Custom", "File Directory") <-resourcename|-rn> resource_name
Table 3-43 lists infacmd RemoveNodeResource options and arguments:

Table 3-43. RemoveNodeResource Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
88
Table 3-43. RemoveNodeResource Options and Arguments Option -nodename -nn -resourcetype -rt Argument node_name resource_type Required/ Optional Required Required Description Name of the node that has the resource you want to remove. Type of resource you want to remove. Valid types include: - Custom - File Directory To specify a file directory resource, enter file directory in quotation marks. For more information about resource types, see Managing the Grid in the Administrator Guide. Entire name of the resource you want to remove. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. To list the names of all resources available to a node, run the ListNodeResources command.
-resourcename -rn
resource_name
Required
RemoveNodeResource
89
RemoveService
Removes an application service from a domain. Use this command to remove a Repository Service, Integration Service, Web Services Hub, or SAP BW Service. Before you remove a service, you must disable it. To run the RemoveService command, you must have full privileges in the Administration Console, permission on the service, and permission on the domain or folder that contains the service. The RemoveService command uses the following syntax:
RemoveService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service
Table 3-44 lists infacmd RemoveService options and arguments:

Table 3-44. RemoveService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of service you want to remove. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
90
ShowLicense
Displays license details. The license details you see are a cumulative result of all license keys applied. The Service Manager updates the existing license details when you add an incremental key to the license. To run the ShowLicense command, you must have permission on the license. The ShowLicense command uses the following syntax:
ShowLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license
Table 3-45 lists infacmd ShowLicense options and arguments:

Table 3-45. ShowLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the license.
period_in_secs
Optional
-licensename -ln
name_of_license
Required
ShowLicense
91
ShutdownNode
Shuts down a node. After you shut down a node, you can restart the node by starting the Informatica Service on the machine. You cannot restart a node using infacmd. To run the ShutdownNode command, you must have permission on the node and full privileges in the Administration Console. The ShutdownNode command uses the following syntax:
ShutdownNode <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name
Table 3-46 lists infacmd ShutdownNode options and arguments:

Table 3-46. ShutdownNode Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node you want to shut down.
period_in_secs
Optional
-nodename -nn
node_name
Required
92
UnassignLicense
Removes a license from an application service. The service must be stopped. You might need to remove a license from a service if the service becomes obsolete. After you remove the license from the service, you cannot enable the service. You must assign a valid license to the service to reenable it. To run the UnassignLicense command, you must have permission on the license and full privileges in the Administration Console. The UnassignLicense command uses the following syntax:
UnassignLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license <-servicenames|-sn> name_of_service1 name_of_service 2 ...
Table 3-47 lists infacmd UnassignLicense options and arguments:

Table 3-47. UnassignLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Arguments name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
-h
Optional
UnassignLicense
93
Table 3-47. UnassignLicense Options and Arguments Option -licensename -ln -servicenames -sn Arguments name_of_license name_of_service1 name_of_service2 ... Required/ Optional Required Required Description Name of the license you want to unassign. Names of the services for which you want to remove the license. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
94
UnassignRSWSHubService
Disassociates a repository from a Web Services Hub Service in a domain. To run the UnassignRSWSHubService command, you must have permission on the Web Services Hub Service and full privileges in the Administration Console. The UnassignRSWSHubService command uses the following syntax:
UnassignRSWSHubService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-repositoryservice|-rs> repository_service_name <-repositorydomain|-rd> domain_of_repository
Table 3-48 lists infacmd UnassignRSWSHubService options and arguments:

Table 3-48. UnassignRSWSHubService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the Web Services Hub Service from which you want to disassociate a repository.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
UnassignRSWSHubService
95
Table 3-48. UnassignRSWSHubService Options and Arguments Option -nodename -nn Argument node_name Required/ Optional Required Description Name of the node where the Web Services Hub Service process runs. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. Name of the Repository Service that the Web Services Hub Service depends on. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
Required
Required
96
UnassociateDomainNode
Disassociates a node in a domain from its address. When you run this command, the node name remains part of the domain, but the node has no physical address. For example, in a domain, Node1 is associated with machine MyHost:9090. When you run this command, the connection between the name Node1 and the host address MyHost:9090 is removed. You can then associate Node1 with a new host. You must run the infasetup DefineGatewayNode or DefineWorkerNode command on the new host to define Node1 on that machine. For more information about these commands, see DefineGatewayNode on page 122 and DefineWorkerNode on page 124. To run the UnassociateDomainNode command, you must have permission on the node and full privileges in the Administration Console. The UnassociateDomainNode command uses the following syntax:
UnassociateDomainNode <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name
Table 3-49 lists infacmd UnassociateDomainNode options and arguments:

Table 3-49. UnassociateDomainNode Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide.
UnassociateDomainNode
97
Table 3-49. UnassociateDomainNode Options and Arguments Option -resiliencetimeout -re Argument period_in_secs Required/ Optional Optional Description Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the node you want to disassociate from the domain.
-nodename -nn
node_name
Required
98
UpdateDomainPassword
Updates the domain administrator password. The UpdateDomainPassword command uses the following syntax:
UpdateDomainPassword <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-newpassword|-np> new_password
Table 3-50 lists infacmd UpdateDomainPassword options and arguments:

Table 3-50. UpdateDomainPassword Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. Administrator name used to connect to the domain. Password for the domain administrator. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. New password for the domain administrator.
period_in_secs
Optional
-newpassword -np
new_password
Required
UpdateDomainPassword
99
UpdateGatewayInfo
Updates gateway node connectivity information. Use this command to update the domains.infa file with current gateway node information. For more information about the domains.infa file, see Before You Install in the Installation and Configuration Guide. The UpdateGatewayInfo command uses the following syntax:
UpdateGatewayInfo <-domainname|-dn> name_of_domain <-gatewayaddress|-dg> domain_gateway_host:port
Table 3-51 lists infacmd UpdateGatewayInfo options and arguments:

Table 3-51. UpdateGatewayInfo Options and Arguments Option -domainname -dn -gatewayaddress -dg Argument name_of_domain domain_gateway_host: port Required/ Optional Required Required Description Name of the domain. Gateway host machine name and port number.
100
UpdateGrid
Updates the list of nodes assigned to a grid. To run the UpdateGrid command, you must have permission on the grid and full privileges in the Administration Console. The UpdateGrid command uses the following syntax:
UpdateGrid <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-gridname|-gn> grid_name <nodelist|-nl node1 node2 ...>
Table 3-52 lists infacmd UpdateGrid options and arguments:

Table 3-52. UpdateGrid Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the grid. Names of the nodes you want to assign to the grid. This list of nodes replaces the list of nodes previously assigned to the grid.
period_in_secs
Optional
-gridname -gn -nodelist -nl
grid_name node1 node2 ...
Required Required
UpdateGrid
101
UpdateIntegrationService
Updates the configuration properties for the Integration Service. To run the UpdateIntegrationService command, you must have permission on the service and full privileges in the Administration Console. The UpdateIntegrationService command uses the following syntax:
UpdateIntegrationService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service [<-nodename|-nn> node_name|<-gridname|-gn> grid_name] [<-backupnodes>-bn] node1 node2 ... [<-repositoryservice|-rs> repository_service_name] [<-repositorydomain|-rd> domain_of_repository] [<-repositoryuser|-ru> repository_user] [<-repositorypwd|-rp> repository_password] [<-serviceoptions|-so> option_name=value ...]
Table 3-53 lists infacmd UpdateIntegrationService options and arguments:

Table 3-53. UpdateIntegrationService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
102
Table 3-53. UpdateIntegrationService Options and Arguments Option -servicename -sn -nodename -nn Argument name_of_service Required/ Optional Required Description Integration Service name. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks. Name of the node where the Integration Service process runs. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. Do not enter a value for this option if you specify the grid name. Name of the grid where the Integration Service process runs. Do not enter a value for this option if you specify the node name. If the PowerCenter environment is configured for high availability, this option specifies the names of the backup nodes. Do not enter values for this option if you specify the grid name. Name of the Repository Service that the Integration Service depends on. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Service properties that define how the Integration Service runs. For more information about Integration Service options, see Integration Service Options on page 41.
node_name
Optional
-gridname -gn
grid_name
Optional
-backupnodes -bn
node1 node2 ...
Optional
Optional
Conditional
-repositoryuser -ru
repository_user
Optional
-repositorypwd -rp
repository_password
Optional
-serviceoptions -so
option_name=value
Optional
UpdateIntegrationService
103
UpdateLicense
Updates license information for a domain. Use this command to upgrade your license using an incremental licence key. You use the key to add or remove licensed options. When you add an incremental key to a license, the Service Manager updates the license expiration date if the expiration date on the incremental key is later than the original key. To run the UpdateLicense command, you must have permission on the license and full privileges in the Administration Console. The UpdateLicense command uses the following syntax:
UpdateLicense <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-licensename|-ln> name_of_license <-licensekeyfile|-lf> license_key_file
Table 3-54 lists infacmd UpdateLicense options and arguments:

Table 3-54. UpdateLicense Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the license object you want to update. Name and path to the file that contains the incremental keys.
period_in_secs
Optional
-licensename -ln -licensekeyfile -lf
name_of_license license_key_file
Required Required
104
UpdateNodeOptions
Updates the resource provision thresholds for a node. Use this command to specify the maximum number of Session and Command tasks that can run on each Integration Service running on the node. To run the UpdateNodeOptions command, you must have permission on the node and full privileges in the Administration Console. The UpdateNodeOptions command uses the following syntax:
UpdateNodeOptions <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-nodename|-nn> node_name <-resourceprovision|-rp> resource_name=value ...
Table 3-55 lists infacmd UpdateNodeOptions options and arguments:

Table 3-55. UpdateNodeOptions Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
period_in_secs
Optional
UpdateNodeOptions
105
Table 3-55. UpdateNodeOptions Options and Arguments Option -nodename -nn -resourceprovision -rp Argument node_name MaxProcesses=value Required/ Optional Optional Required Description Name of the node whose resource provision thresholds you want to update. The resource provision thresholds you want to update. You can update Maximum Processes, the maximum number of Session and Command tasks that can run on each Integration Service running on the node. The following example sets this provision to 15: infacmd UpdateNodeOptions ... -rp MaxProcesses=15
106
UpdateRepositoryService
Updates the service options for the Repository Service. Use this command to update or create service options for the Repository Service. For example, you can update the Repository Service operating mode, which you can set to normal or exclusive. Normal mode allows multiple users to access the Repository Service and update repository contents. Exclusive mode allows a single user to access the Repository Service and update repository contents. Set the operating mode to exclusive when you perform administrative tasks that require a single user to log in and update the configuration. To update the Repository Service operating mode, disable the Repository Service, update the operating mode, and then reenable the Repository Service. To run the UpdateRepositoryService command, you must have permission on the service and full privileges in the Administration Console. The UpdateRepositoryService command uses the following syntax:
UpdateRepositoryService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service [<-nodename|-nn> node_name] [<-backupnodes|-bn> node1 node2 ...] <-serviceoptions|-so> option_name=value ...
Table 3-56 lists infacmd UpdateRepositoryService options and arguments:

Table 3-56. UpdateRepositoryService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument domain_name user_name password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide.
UpdateRepositoryService
107
Table 3-56. UpdateRepositoryService Options and Arguments Option -resiliencetimeout -re Argument period_in_secs Required/ Optional Optional Description Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the Repository Service you want to update. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Name of the node where the Repository Service process runs. If the PowerCenter environment is configured for high availability, this option specifies the name of the primary node. If the PowerCenter environment is configured for high availability, this option specifies the names of the backup nodes. Service properties that define how the Repository Service runs. For more information about Repository Service options, see Repository Service Options on page 47.
-servicename -sn
name_of_service
Required
-nodename -nn
node_name
Optional
-backupnodes -bn -serviceoptions -so
node1 node2 ...
Optional
option_name=value
Required
108
UpdateServiceProcess
Updates the values of Integration Service process options. To run the UpdateServiceProcess command, you must have permission on the service and full privileges in the Administration Console. The UpdateServiceProcess command uses the following syntax:
UpdateServiceProcess <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port ...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-serviceprocessoptions|-po> option_name=value...
Table 3-57 lists infacmd UpdateServiceProcess options and arguments:

Table 3-57. UpdateServiceProcess Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the service. To enter a name that contains a space or other non-alphanumeric character, enclose the name in quotation marks.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
UpdateServiceProcess
109
Table 3-57. UpdateServiceProcess Options and Arguments Option -nodename -nn -serviceprocessoptions -pc Argument node_name option_name=value Required/ Optional Required Required Description Name of the node where you want to update configuration information. Name and new values of the options whose values you want to update. You can specify multiple option_name=value pairs. You can use a process variable in the value. For example, the following command sets the cache directory to $PMRootDir/NewCache and the reject file directory to $PMRootDir/ NewBadFiles: infacmd UpdateServiceProcess ... -po $PMCacheDir=$PMRootDir/NewCache $PMBadFileDir=$PMRootDir/NewBadFiles For more information about service process options, see Service Process Options on page 44.
110
UpdateWSHubService
Updates a Web Services Hub Service in a domain. For more information about Web Services Hub Services, see the Web Services Provider Guide. To run the UpdateWSHubService command, you must have permission on the service and full privileges in the Administration Console. The UpdateWSHubService command uses the following syntax:
UpdateWSHubService <-domainname|-dn> name_of_domain <-username|-un> name_of_user <-password|-pd> password [<-gateway|-hp> gateway_host1:port gateway_host2:port...] [<-resiliencetimeout|-re> period_in_secs] <-servicename|-sn> name_of_service <-nodename|-nn> node_name <-repositoryservice|-rs> repository_service_name <-repositorydomain|-rd> domain_of_repository <-repositoryuser|-ru> repository_user <-repositorypwd|-rp> repository_password <-serviceoptions|-so> option_name=value ...
Table 3-58 lists infacmd UpdateWSHubService options and arguments:

Table 3-58. UpdateWSHubService Options and Arguments Option -domainname -dn -username -un -password -pd -gateway -hp Argument name_of_domain name_of_user password gateway_host1:port gateway_host2:port ... Required/ Optional Required Required Required Conditional Description Name of the domain. User name used to connect to the domain. Password for the domain user name. The password is case-sensitive. The host names and port numbers for the gateway nodes in the domain. Required if the gateway connectivity information in the domains.infa file is out of date. For more information about domains.infa, see Before You Install in the Installation and Configuration Guide. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. If you omit this option, infacmd uses the timeout value specified in the INFA_CLIENT_RESILIENCE_ TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used. Name of the Web Services Hub Service you want to update.
period_in_secs
Optional
-servicename -sn
name_of_service
Required
UpdateWSHubService
111
Table 3-58. UpdateWSHubService Options and Arguments Option -nodename -nn -repositoryservice -rs Argument node_name repository_service_ name Required/ Optional Required Required Description Name of the node where the Web Services Hub Service process runs. Name of the Repository Service that the Web Services Hub Service depends on. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Domain of the Repository Service. Required if the repository is in a domain other than the local domain. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. User name used to connect to the repository. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Repository user password. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks. Service properties that define how the Web Services Hub Service runs. For more information about Web Services Hub Service options, see Web Services Hub Service Options on page 51.
domain_of_ repository
Conditional
-repositoryuser -ru
repository_user
Required
-repositorypwd -rp
repository_password
Required
-serviceoptions -so
option_name=value ...
Required
112
Chapter 4
infasetup Commands Reference

This chapter contains the following topics:

Using infasetup, 114 infasetup Commands, 116
113
Using infasetup
infasetup is a command line program that allows you to administer PowerCenter domain and node properties. Use infasetup to modify domain and node properties after you install PowerCenter Services with the PowerCenter installation program. For example, you can use infasetup to change the port number for a node after you install PowerCenter Services. You can use infasetup to back up, restore, and define domains, and to define and update nodes. For more information, see infacmd Commands Reference on page 19.
Running Commands
You invoke infasetup from the command line. You can issue commands directly or from a script, batch file, or other program. On Windows, infasetup is a batch file with a .bat extension. On UNIX, infasetup is a script file with a .sh extension.
To run infasetup commands: 1.
At the command prompt, switch to the directory where the infasetup executable is located. By default, infasetup installs in the server directory.
2.
Enter infasetup on Windows or infasetup.sh on UNIX followed by the command name and its required options and arguments. The command names are not casesensitive. For example:
infasetup(.sh) command_name [-option1] argument_1 [-option2] argument_2...
Command Options
When you run infasetup, you enter options for each command, followed by the required arguments. Command options are preceded by a hyphen and are not case-sensitive. Arguments follow the option. For example, the following command updates a worker node with the name Node1 and the address Host1:9090:
infasetup UpdateWorkerNode -nn Node1 -na Host1:9090
If you omit or incorrectly enter one of the required options, the command fails, and infasetup returns an error message. For a description of infasetup error messages, see ICMD Messages in the Troubleshooting Guide.
Return Codes
infasetup indicates the success or failure of a command with a return code. Return code (0) indicates that the command succeeded. Return code (-1) indicates that the command failed.
114 Chapter 4: infasetup Commands Reference
Use the DOS or UNIX echo command immediately after running an infasetup command to see the return code for the command:

Using infasetup
115
infasetup Commands
Table 4-1 describes the infasetup commands:
Table 4-1. infasetup Commands Command BackupDomain DefineDomain DefineGatewayNode DefineWorkerNode Help RestoreDomain UpdateGatewayNode UpdateWorkerNode Description Backs up the configuration metadata for the domain. For more information, see BackupDomain on page 117. Defines a domain on the current machine. For more information, see DefineDomain on page 119. Defines a gateway node on the current machine. For more information, see DefineGatewayNode on page 122. Defines a worker node on the current machine. For more information, see DefineWorkerNode on page 124. Returns the syntax for the command you specify. Lists the options for the command. For more information, see Help on page 126. Restores the configuration metadata for the domain. For more information, see RestoreDomain on page 127. Updates connectivity information for a gateway node. For more information, see UpdateGatewayNode on page 129. Updates connectivity information for a worker node. For more information, see UpdateWorkerNode on page 131.
116
Chapter 4: infasetup Commands Reference
BackupDomain
Backs up the configuration metadata for the domain. infasetup stores the backup domain metadata in an XML file. When you run this command, infasetup backs up the PCSF_DOMAIN domain configuration database table. If you want to restore the domain into a new database, you must back up the following tables manually:

PCSF_CPU_USAGE_SUMMARY PCSF_REPO_USAGE_SUMMARY PCSF_RUN_LOG
For more information about backing up a domain, see Managing the Domain in the Administrator Guide. The BackupDomain command uses the following syntax:
BackupDomain <-databaseaddress|-da> database_hostname:database_port <-databaseusername|-du> database_username <-databasepassword|-dp> database_password <-databasetype|-dt> database_type [<-databaseservicename|-ds> database_service_name] <-backupfile|-bf> back_file_location [<-force|-f>] <-domainname|-dn> name_of_domain
Table 4-2 lists infasetup BackupDomain options and arguments:

Table 4-2. BackupDomain Options and Arguments Option -databaseaddress -da -databaseusername -du -databasepassword -dp -databasetype -dt -databaseservicename -ds -backupfile -bf Argument database_hostname: database_port database_username database_password Required/ Optional Required Required Conditional Description Name and port number of the machine hosting the domain configuration database. Account for the database containing the domain configuration information. Domain configuration database password corresponding to the database user. Must be in 7bit ASCII. Type of database that stores the domain configuration metadata. The database service name. Required for Oracle and DB2 databases. Enter the SID for Oracle or the service name for DB2. Name and file path for the backup file. If you do not specify a file path, infasetup creates the backup file in the current directory.
database_type database_service_ name back_file_location
Required Conditional
Required
BackupDomain
117
Table 4-2. BackupDomain Options and Arguments Option -force -f -domainname -dn Argument n/a name_of_domain Required/ Optional Optional Required Description Overwrites the backup file if a file with the same name already exists. Name of the domain.
118
DefineDomain
Creates a domain on the current machine. If you define a domain on a machine that currently hosts a domain, you must first stop the Informatica Services on the machine. When you run this command, infasetup removes the existing domain and node settings. After you define the new domain, restart the Informatica Services. To create a domain on a Windows machine, you must first open the host port or disable the firewall. The DefineDomain command uses the following syntax:
DefineDomain <-domainname|-dn> name_of_domain <-administratorname|-ad> administrator_name <-password|-pd> password <-logservicedirectory|-ld> logservice_directory <-nodename|-nn> node_name <-nodeaddress|-na> nodehost:port <-minprocessport|-mi> minimum_port <-maxprocessport|-ma> maximum_port [<-serverport|-sv> server_admin_port_number] [<-backupdirectory|-bd> backup_directory] [<-errorloglevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG] <-resourcefile|-rf> resource_file <-databaseaddress|-da> database_hostname:database_port <-databaseusername|-du> database_username <-databasepassword|-dp> database_password <-databasetype|-dt> database_type [<-databaseservicename|-ds> database_service_name] [<-timezone|-tz> logservice_timezone_GMT+00:00] [<-force|-f>]
Table 4-3 lists infasetup DefineDomain options and arguments:

Table 4-3. DefineDomain Options and Arguments Option -domainname -dn Argument name_of_domain Required/ Optional Required Description Name of the domain. Domain names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Domain administrator user name. Domain administrator password.
-administratorname -ad -password -pd
administrator_name password
Required Required
DefineDomain
119
Table 4-3. DefineDomain Options and Arguments Option -logservicedirectory -ld Argument logservice_directory Required/ Optional Optional Description Shared directory path used by the Log Manager to store log event files. For more information about the Log Manager, see Managing Logs in the Administrator Guide. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Host name and port number for the machine hosting the node. Choose an available port number. Minimum port number for application service processes that run on the node. Maximum port number for application service processes that run on the node. TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use. Default is 8005. Directory to store repository backup files. The directory must be accessible by the node. Severity level for log events in the domain log. Default is info.
-nodename -nn
node_name
Required
-nodeaddress -na -minprocessport -mi -maxprocessport -ma -serverport -sv
nodehost:port minimum_port maximum_port server_admin_port_ number
Required Required Required Optional
-backupdirectory -bd -errorloglevel -el
backup_directory fatal error warning info trace debug resource_file
Required Optional
-resourcefile -rf -databaseaddress -da -databaseusername -du -databasepassword -dp
Required
File that contains the list of available resources for the node. Use the file, nodeoptions.xml, located in the server\tomcat\bin directory. Name and port number of the machine hosting the domain configuration database. Account for the database containing the domain configuration information. Domain configuration database password corresponding to the database user. Must be in 7-bit ASCII. If you omit this option, infasetup uses the password specified in the INFA_DEFAULT_DATABASE_PASSWORD environment variable. If no value is specified in the environment variable, you must enter a password using this option.
database_hostname: database_port database_username database_password
Required Required Conditional
120
Table 4-3. DefineDomain Options and Arguments Option -databasetype -dt -databaseservicename -ds -timezone -tz Argument database_type database_service_ name logservice_timezone Required/ Optional Required Conditional Description Type of database that stores the domain configuration metadata. The database service name. Required for Oracle and DB2 databases. Enter the SID for Oracle or the service name for DB2. Time zone used by the Log Manager when it generates log event files. Configure the time zone in the following format:
GMT(+/-)hh:mm
Optional
For more information about the Log Manager, see Managing Logs in the Administrator Guide. -force -f n/a Optional Overwrites the database if a database with the same name already exists.
If you run DefineDomain on a node that currently hosts a domain, reconfigure the following domain properties:
Application services. Recreate any application service that ran on the domain. For more information, see Creating and Configuring the Integration Service and Creating and Configuring the Repository Service in the Administrator Guide. Domain users. Recreate domain users. For more information about creating domain users, see Managing the Domain in the Administrator Guide. Gateway nodes. Configure the gateway nodes in the domain. For more information about configuring gateway nodes, see Managing the Domain in the Administrator Guide. General domain properties. Configure resilience timeout and maximum restart attempts for the domain. For more information about configuring domain properties, see Managing the Domain in the Administrator Guide. Grids. Recreate any grid in the domain. For more information about creating a grid, see Managing the Grid in the Administrator Guide. LDAP authentication. Configure LDAP authentication for the domain. For more information about LDAP authentication, see Managing Security in the Administrator Guide. Log Manager properties. Configure the Log Manager shared directory path, purge properties, and time zone. For more information about configuring the Log Manager, see Managing Logs in the Administrator Guide.
If you change the gateway node host name or port number, you must also add each node to the domain using the infacmd AddDomainNode command. For more information, see AddDomainNode on page 27.
DefineDomain
121
DefineGatewayNode
Defines a gateway node on the current machine. This command overwrites the nodemeta.xml file that stores the configuration metadata for the node. After you define the node, you must add it to the domain using the infacmd AddDomainNode command. For more information, see AddDomainNode on page 27. The DefineGatewayNode command uses the following syntax:
DefineGatewayNode <-databaseaddress|-da> database_hostname:database_port <-databaseusername|-du> database_username <-databasepassword|-dp> database_password <-databasetype|-dt> database_type [<-databaseservicename|-ds> database_service_name] <-domainname|-dn> name_of_domain <-nodename|-nn> node_name <-nodeaddress|-na> nodehost:port [<-minprocessport|-mi> minimum_port] [<-maxprocessport|-ma> maximum_port] <-logservicedirectory|-ld> logservice_directory [<-backupdirectory|-bd> backup_directory] [<-errorloglevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG] [<-serverport|-sv> server_admin_port_number] <-resourcefile|-rf> resource_file
Table 4-4 lists infasetup DefineGatewayNode options and arguments:

Table 4-4. DefineGatewayNode Options and Arguments Option -databaseaddress -da -databaseusername -du -databasepassword -dp Argument database_hostname: database_port database_username database_password Required/ Optional Required Required Required Description Name and port number of the machine hosting the domain configuration database. Account for the database containing the domain configuration information. Domain configuration database password corresponding to the database user. Must be in 7-bit ASCII. If you omit this option, infasetup uses the password specified in the INFA_DEFAULT_DATABASE_PASSWORD environment variable. If no value is specified in the environment variable, you must enter a password using this option. Type of database that stores the domain configuration metadata. The database service name. Required for Oracle and DB2 databases. Enter the SID for Oracle or the service name for DB2.
-databasetype -dt -databaseservicename -ds
database_type database_service_ name
122
Table 4-4. DefineGatewayNode Options and Arguments Option -domainname -dn -nodename -nn Argument name_of_domain node_name Required/ Optional Required Required Description Name of the domain the gateway node links to. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Host name and port number for the machine hosting the node. Choose an available port number. Minimum port number for application service processes that run on the node. Default is 11000. Maximum port number for application service processes that run on the node. Default is 11999. Shared directory path used by the Log Manager to store log event files. For more information about the Log Manager, see Managing Logs in the Administrator Guide. Directory to store repository backup files. The directory must be accessible by the node. Severity level for log events in the domain log. Default is info.
-nodeaddress -na -minprocessport -mi -maxprocessport -ma -logservicedirectory -ld
nodehost:port
Required
minimum_port
Optional
maximum_port
Optional
logservice_directory
Required
-backupdirectory -bd -errorloglevel -el
backup_directory fatal error warning info trace debug server_admin_port_ number
Optional Optional
-serverport -sv
Optional
TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use. Default is 8005. File that contains the list of available resources for the node. Use the file, nodeoptions.xml, located in the server\tomcat\bin directory.
-resourcefile -rf
resource_file
Required
DefineGatewayNode
123
DefineWorkerNode
Defines a worker node on the current machine. If you define a new worker node, this command creates the nodemeta.xml file that stores the configuration metadata for the node. If you run this command on an existing node, it overwrites the node configuration metadata. After you define the node, you must add it to the domain using the infacmd AddDomainNode command. For more information, see AddDomainNode on page 27. The DefineWorkerNode command uses the following syntax:
DefineWorkerNode <-domainname|-dn> name_of_domain <-nodename|-nn> node_name <-nodeaddress|-na> nodehost:port <-gatewayaddress|-dg> domain_gateway_host:port <-administratorname|-ad> administrator_name <-password|-pd> password [<-minprocessport|-mi> minimum_port] [<-maxprocessport|-ma> maximum_port] [<-backupdirectory|-bd> backup_directory] [<-errorloglevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG] [<-serverport|-sv> server_admin_port_number] <-resourcefile|-rf> resource_file
Table 4-5 lists infasetup DefineWorkerNode options and arguments:

Table 4-5. DefineWorkerNode Options and Arguments Option -domainname -dn -nodename -nn Argument name_of_domain node_name Required/ Optional Required Required Description Name of the domain the worker node links to. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Host name and port number for the machine hosting the node. Choose an available port number. Gateway host machine name and port number. Domain administrator user name. User name must be between 3 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Domain administrator password. Passwords must be between 3 and 16 characters. Minimum port number for application service processes that run on the node. Default is 11000.
-nodeaddress -na -gatewayaddress -dg -administratorname -ad
nodehost:port
Required
domain_gateway_ host:port administrator_name
Required Required
-password -pd -minprocessport -mi
password minimum_port
Required Optional
124
Table 4-5. DefineWorkerNode Options and Arguments Option -maxprocessport -ma -backupdirectory -bd -errorloglevel -el Argument maximum_port backup_directory fatal error warning info trace debug server_admin_port_ number Required/ Optional Optional Optional Optional Description Maximum port number for application service processes that run on the node. Default is 11999. Directory to store repository backup files. The directory must be accessible by the node. Severity level for log events in the domain log. Default is info.
-serverport -sv
Optional
TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use. Default is 8005. File that contains the list of available resources for the node. Use the file, nodeoptions.xml, located in the server\tomcat\bin directory.
-resourcefile -rf
resource_file
Required
DefineWorkerNode
125
Help
The Help command displays the options and arguments for a command. If you omit the command name, infasetup lists all commands. The Help command uses the following syntax:
Help [command]
For example, if you type infasetup Help UpdateWorkerNode, infasetup returns the following options and arguments for the UpdateWorkerNode command:
Usage: UpdateWorkerNode [<-domainname|-dn> name_of_domain] [<-nodename|-nn> node_name] [<-nodeaddress|-na> nodehost:port] [<-gatewayaddress|-dg> domain_gateway_host:port] [<-administratorname|-ad> administrator_name] [<-password|-pd> password] [<-serverport|-sv> server_admin_port_number]
Table 4-6 lists infasetup Help options and arguments:

Table 4-6. Help Options and Arguments Option n/a Argument command Required/ Optional Optional Description Name of command. If you omit the command name, infasetup lists all commands.
126
RestoreDomain
Restores the configuration metadata for the domain from a backup XML file. You must shut down the domain before you run this command. When you run this command, infasetup restores the PCSF_DOMAIN domain configuration database table. If you restore the domain into a database other than the original backup database, you must restore the following tables manually:

PCSF_CPU_USAGE_SUMMARY PCSF_REPO_USAGE_SUMMARY PCSF_RUN_LOG
For more information about backing up and restoring domains, see Managing the Domain in the Administrator Guide. The RestoreDomain command uses the following syntax:
RestoreDomain <-databaseaddress|-da> database_hostname:database_port <-databaseusername|-du> database_username <-databasepassword|-dp> database_password <-databasetype|-dt> database_type [<-databaseservicename|-ds> database_service_name] <-backupfile|-bf> back_file_location [<-force|-f>] [<-clearnodeassociation|-ca>]
Table 4-7 lists infacmd RestoreDomain options and arguments:

Table 4-7. RestoreDomain Options and Arguments Option -databaseaddress -da -databaseusername -du -databasepassword -dp -databasetype -dt -databaseservicename -ds -backupfile -bf Argument database_hostname: database_port database_username database_password Required/ Optional Required Required Conditional Description Name and port number of the machine where you want to restore the domain configuration database. Account for the database containing the domain configuration information. Domain configuration database password corresponding to the database user. Must be in 7bit ASCII. Type of database that stores the domain configuration metadata. The database service name. Required for Oracle and DB2 databases. Enter the SID for Oracle or the service name for DB2. Name and file path for the backup file. If you do not specify a file path, infacmd looks for the backup file in the directory where you run infacmd.
database_type database_service_ name back_file_location
Required
RestoreDomain
127
Table 4-7. RestoreDomain Options and Arguments Option -force -f -clearnodeassociation -ca Argument n/a n/a Required/ Optional Optional Optional Description Overwrites the database if a database with the same name already exists. Clears node associations when restoring the domain. For example, a backed up domain contains node Node1 on machine MyHost:9090. If you specify this option, the connection between the node name Node1 and the address MyHost:9090 is broken when you restore the domain. You can then associate another node with MyHost:9090. If you do not specify this option, Node1 retains its connection to MyHost:9090. If you restore the domain and associate another node with MyHost:9090, the node does not start.
128
UpdateGatewayNode
Updates connectivity information for a gateway node on the current machine. To run this command, you must first shut down the node.
Warning: If the domain contains a single gateway node, and you update the node address using this command, the Service Manager will not be able to communicate with the node when you restart the node. If this happens, back up the domain, update the node address in the backup file, and restore the database.
The UpdateGatewayNode command uses the following syntax:

UpdateGatewayNode [<-databaseaddress|-da> database_hostname:database_port] [<-databaseusername|-du> database_username] [<-databasepassword|-dp> database_password] [<-databasetype|-dt> database_type] [<-databaseservicename|-ds> database_service_name] [<-domainname|-dn> name_of_domain] [<-nodename|-nn> node_name] [<-nodeaddress|-na> nodehost:port] [<-logservicedirectory|-ld> logservice_directory] [<-serverport|-sv> server_admin_port_number]
Table 4-8 lists infasetup UpdateGatewayNode options and arguments:

Table 4-8. UpdateGatewayNode Options and Arguments Option -databaseaddress -da -databaseusername -du -databasepassword -dp -databasetype -dt -databaseservicename -ds -domainname -dn -nodename -nn Argument database_hostname: database_port database_username database_password Required/ Optional Optional Optional Optional Description Name and port number of the machine hosting the domain configuration database. Account for the database containing the domain configuration information. Domain configuration database password corresponding to the database user. Must be in 7-bit ASCII. Type of database that stores the domain configuration metadata. The database service name. Required for Oracle and DB2 databases. Enter the SID for Oracle or the service name for DB2. Name of the domain. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " |
database_type database_service_ name name_of_domain node_name
Optional Optional
Optional Optional
UpdateGatewayNode
129
Table 4-8. UpdateGatewayNode Options and Arguments Option -nodeaddress -na -logservicedirectory -ld Argument nodehost:port Required/ Optional Optional Description Host name and port number for the machine hosting the node. Choose an available port number. Shared directory path used by the Log Manager to store log event files. For more information about the Log Manager, see Managing Logs in the Administrator Guide. TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use.
logservice_directory
Optional
-serverport -sv
server_admin_port_ number
Optional
130
UpdateWorkerNode
Updates connectivity information for a worker node on the current machine. To run this command, you must first shut down the node. The UpdateWorkerNode command uses the following syntax:
UpdateWorkerNode [<-domainname|-dn> name_of_domain] [<-nodename|-nn> node_name] [<-nodeaddress|-na> nodehost:port] [<-gatewayaddress|-dg> domain_gateway_host:port] [<-administratorname|-ad> administrator_name] [<-password|-pd> password] [<-serverport|-sv> server_admin_port_number]
Table 4-9 lists infasetup UpdateWorkerNode options and arguments:

Table 4-9. UpdateWorkerNode Options and Arguments Option -domainname -dn -nodename -nn Argument name_of_domain node_name Required/ Optional Optional Optional Description Name of the domain. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: / * ? < > " | Host name and port number for the machine hosting the node. Choose an available port number. Gateway host machine name and port number. Domain administrator user name. Domain administrator password. TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use.
-nodeaddress -na -gatewayaddress -dg -administratorname -ad -password -pd -serverport -sv
nodehost:port
Optional
domain_gateway_ host:port administrator_name password server_admin_port_ number
UpdateWorkerNode
131
132
Chapter 5
pmcmd Commands Reference


Using pmcmd, 134 pmcmd Commands, 140
133
Using pmcmd
pmcmd is a program you use to communicate with the Integration Service. With pmcmd, you can perform some of the tasks that you can also perform in the Workflow Manager, such as starting and stopping workflows and sessions. Use pmcmd in the following modes:
Command line mode. You invoke and exit pmcmd each time you issue a command. You can write scripts to schedule workflows with the command line syntax. Each command you write in command line mode must include connection information to the Integration Service. Interactive mode. You establish and maintain an active connection to the Integration Service. This lets you issue a series of commands.
You can use environment variables for repository user names and passwords with pmcmd. You can also use environment variables to customize the way pmcmd displays the date and time on the machine running the Integration Service process. Before you use pmcmd, configure these variables on the machine running the Integration Service process. For more information, see Configuring Environment Variables on page 5.
Running Commands in Command Line Mode

Command line mode invokes and exits pmcmd each time you issue a command. Command line mode is useful if you want to run pmcmd commands through batch files, scripts, or other programs. For more information about scripting pmcmd commands, see Scripting pmcmd Commands on page 138. Use pmcmd commands with operating system scheduling tools like cron, or you can embed pmcmd commands into shell or Perl scripts. When you run pmcmd in command line mode, you enter connection information such as domain name, Integration Service name, user name and password in each command. For example, to start the workflow wf_SalesAvg in folder SalesEast, use the following syntax:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast wf_SalesAvg
The user, seller3, with the password jackson sends the request to start the workflow. If you omit or incorrectly enter one of the required options, the command fails, and pmcmd returns a non-zero return code. For a description of all the return codes, see Table 5-1 on page 135. For a list of commands in command line mode, see pmcmd Commands on page 140.
To run pmcmd commands in command line mode: 1.
At the command prompt, switch to the directory where the pmcmd executable is located. By default, the PowerCenter installer installs pmcmd in the \server\bin directory.
134
Chapter 5: pmcmd Commands Reference
2.
Enter pmcmd followed by the command name and its required options and arguments:
pmcmd command_name [-option1] argument_1 [-option2] argument_2...
Return Codes
In command line mode, pmcmd indicates the success or failure of a command with a return code. Return code (0) indicates that the command succeeded. Any other return code indicates that the command failed. Use the DOS or UNIX echo command immediately after running a pmcmd command to see the return code for the command:

Table 5-1 describes the return codes for pmcmd:

Table 5-1. pmcmd Return Codes Code 0 Description For all commands, a return value of zero indicates that the command ran successfully. You can issue the following commands in the wait or nowait mode: starttask, startworkflow, aborttask, and abortworkflow. If you issue a command in the wait mode, a return value of zero indicates the command ran successfully. If you issue a command in the nowait mode, a return value of zero indicates that the request was successfully transmitted to the Integration Service, and it acknowledged the request. Integration Service is not available, or pmcmd cannot connect to the Integration Service. There is a problem with the TCP/IP host name or port number or with the network. Task name, workflow name, or folder name does not exist. An error occurred starting or running the workflow or task. Usage error. You passed the wrong options to pmcmd. An internal pmcmd error occurred. Contact Informatica Technical Support. You used an invalid user name or password. You do not have the appropriate permissions or privileges to perform this task. Connection to the Integration Service timed out while sending the request. Integration Service cannot start recovery because the session or workflow is scheduled, waiting for an event, waiting, initializing, aborting, stopping, disabled, or running. User name environment variable is set to an empty value. Password environment variable is set to an empty value. User name environment variable is missing. Password environment variable is missing. Parameter file does not exist.
1 2 3 4 5 7 8 9 12 13 14 15 16 17
Using pmcmd
135
Table 5-1. pmcmd Return Codes Code 18 19 20 21 22 23 24 25 Description Integration Service found the parameter file, but it did not have the initial values for the session parameters, such as $input or $output. Integration Service cannot resume the session because the workflow is configured to run continuously. A repository error has occurred. Make sure that the Repository Service and the database are running and the number of connections to the database is not exceeded. Integration Service is shutting down and it is not accepting new requests. Integration Service cannot find a unique instance of the workflow/session you specified. Enter the command again with the folder name and workflow name. There is no data available for the request. Out of memory. Command is cancelled.
Running Commands in Interactive Mode

Use pmcmd in interactive mode to start and stop workflows and sessions without writing a script. When you use the interactive mode, you enter connection information such as domain name, Integration Service name, user name, and password. You can run subsequent commands without entering the connection information for each command. For example, the following commands invoke the interactive mode, establish a connection to Integration Service MyIntService, and start workflows wf_SalesAvg and wf_SalesTotal in folder SalesEast:
pmcmd pmcmd> connect -sv MyIntService -d MyDomain -u seller3 -p jackson pmcmd> setfolder SalesEast pmcmd> startworkflow wf_SalesAvg pmcmd> startworkflow wf_SalesTotal
For a list of commands available in interactive mode, see pmcmd Commands on page 140.
To run pmcmd commands in interactive mode: 1.
At the command prompt, switch to the directory where the pmcmd executable is located. By default, the PowerCenter installer installs pmcmd in the \server\bin directory.
2.
At the command prompt, type pmcmd. This starts pmcmd in interactive mode and displays the pmcmd> prompt. You do not have to type pmcmd before each command in interactive mode.
3.
Enter connection information for the domain and Integration Service. For example:
connect -sv MyIntService -d MyDomain -u seller3 -p jackson
136
4.
Type a command and its options and arguments in the following format:
command_name [-option1] argument_1 [-option2] argument_2...
pmcmd runs the command and displays the prompt again.

5.
Type exit to end an interactive session.
Setting Defaults
After you connect to an Integration Service using pmcmd, you can designate default folders or conditions to use each time the Integration Service executes a command. For example, if you want to issue a series of commands or tasks in the same folder, specify the name of the folder with the setfolder command. All subsequent commands use that folder as the default. Table 5-2 describes the commands that you use to set defaults for subsequent commands:
Table 5-2. Setting Defaults for Interactive Mode Command setfolder setnowait setwait unsetfolder Description Designates a folder as the default folder in which to execute all subsequent commands. Executes subsequent commands in the nowait mode. The pmcmd prompt is available after the Integration Service receives the previous command. The nowait mode is the default mode. Executes subsequent commands in the wait mode. The pmcmd prompt is available after the Integration Service completes the previous command. Reverses the setfolder command.
You can use the showsettings command to display the default settings. For more information about the showsettings command, see showsettings on page 170.
Running in Wait Mode

You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt after the command completes. You cannot run subsequent commands until the previous command completes. For example, if you enter the following command, pmcmd starts the workflow wf_SalesAvg and does not return to the prompt until the workflow completes:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast -wait wf_SalesAvg
In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to wait for one command to complete before running the next command. For example, if you enter the following commands, pmcmd starts workflow wf_SalesTotal even if workflow wf_SalesAvg is still running:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast wf_SalesAvg pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast wf_SalesTotal Using pmcmd 137
By default pmcmd executes commands in nowait mode. You can configure the wait mode when you run in command line or interactive mode. In command line mode, use the -wait option to run a command in wait mode. In interactive mode, use the setwait or setnowait command before entering subsequent commands.
Scripting pmcmd Commands

When you use pmcmd, you might use some commands with specific options and arguments on a regular basis. For example, you might use pmcmd to check the status of the Integration Service. In this case, you can create a script or batch file to call one or more pmcmd commands including its options and arguments. You can run scripts in command line mode. You cannot run pmcmd scripts in interactive mode. For example, the following UNIX shell script checks the status of Integration Service testService, and if it is running, gets details for session s_testSessionTask:
#!/usr/bin/bash # Sample pmcmd script # Check if the service is alive pmcmd pingservice -sv testService -d testDomain if [ "$?" != 0 ]; then # handle error echo "Could not ping service" exit fi # Get service properties pmcmd getserviceproperties -sv testService -d testDomain
if [ "$?" != 0 ]; then # handle error echo "Could not get service properties" exit fi # Get task details for session task "s_testSessionTask" of workflow # "wf_test_workflow" in folder "testFolder" pmcmd gettaskdetails -sv testService -d testDomain -u Administrator -p adminPass -folder testFolder -workflow wf_test_workflow s_testSessionTask if [ "$?" != 0 ]; then # handle error echo "Could not get details for task s_testSessionTask" exit fi
Entering Command Options

pmcmd provides multiple ways to enter some of the command options and arguments. For example, to enter a repository password, use the following syntax:
138
<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
To enter a password, precede the password with the -password or -p option.

-password ThePassword or -p ThePassword
If you use a password environment variable, precede the variable name with the -pv or -passwordvar option.
-passwordvar PASSWORD or -pv PASSWORD
If a command option contains spaces, use single or double quotation marks to enclose the option. For example, use single quotes in the following syntax to enclose the folder name:
abortworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f 'quarterly sales' -wait wf_MyWorkflow
To denote an empty string, use two single quotes ('') or two double quotes ("").
Using pmcmd
139
pmcmd Commands
pmcmd includes a library of commands to communicate with the Integration Service. Use pmcmd to administer sessions and workflows. Table 5-3 describes pmcmd commands:
Table 5-3. pmcmd Commands Command aborttask Modes Command line, Interactive Command line, Interactive Interactive Description Aborts a task. Issue this command only if the Integration Service fails to stop when you issue the stoptask command. For more information, see aborttask on page 143. Aborts a workflow. Issue this command only if the Integration Service fails to stop the workflow when you issue the stopworkflow command. For more information, see abortworkflow on page 145. Connects to the Integration Service in the interactive mode. Use this command in conjunction with connection information. For more information, see connect on page 147. Disconnects from the Integration Service in the interactive mode. For more information, see disconnect on page 148. Exits from pmcmd in the interactive mode. For more information, see exit on page 149. Displays details for sessions currently running on an Integration Service including information for the folder, workflow, and session instance. Displays session status and statistics for each target and source qualifier. For more information, see getrunningsessionsdetails on page 150. Displays details for the Integration Service including service status, information on active workflows, and timestamp information. In a server grid, this command displays the Integration Service that runs each task instance. For more information, see getservicedetails on page 152. Displays the Integration Service name, type, and version. It returns the timestamp on the Integration Service and the name of the repository. It also indicates the data movement mode and whether the Integration Service can debug mappings. For more information, see getserviceproperties on page 154. Displays session details including information for the folder, workflow, and task instance. Displays session status and statistics for each target and source qualifier. In a server grid, this command displays the Integration Service that runs each task instance. For more information, see getsessionstatistics on page 155.
abortworkflow
connect
disconnect exit getrunningsessionsdetails
Interactive Interactive Command line, Interactive
getservicedetails
Command line, Interactive
getserviceproperties
getsessionstatistics
140
Table 5-3. pmcmd Commands Command gettaskdetails Modes Command line, Interactive Description Displays details for a task including folder and workflow name. Also displays the task, status, and run mode. In a server grid, this command displays the Integration Service that runs each task instance. For more information, see gettaskdetails on page 157. Displays details for a workflow including workflow name, status, and run mode. Also displays information about the last workflow run. For more information, see getworkflowdetails on page 159. Displays a list of pmcmd commands and syntax. For more information, see help on page 161. Determines whether the Integration Service is running. For more information, see pingservice on page 162. Recovers a suspended workflow. For more information, see recoverworkflow on page 163. Instructs the Integration Service to schedule a workflow. Use this command to manually reschedule a workflow that has been removed from the schedule. For more information, see scheduleworkflow on page 165. Designates a folder as the default folder in which to execute subsequent commands. For more information, see setfolder on page 167. Instructs the Integration Service to execute subsequent commands in nowait mode. In nowait mode, you can enter a new pmcmd command after the Integration Service receives the previous command. For more information, see setnowait on page 168. Instructs the Integration Service to execute subsequent commands in wait mode. In wait mode, you can enter a new pmcmd command only after the Integration Service completes the previous command. For more information, see setwait on page 169. Displays the settings for the interactive mode, including Integration Service and repository name, user name, wait mode, and default folder. For more information, see showsettings on page 170. Starts a task. For more information, see starttask on page 171. Starts a workflow. For more information, see startworkflow on page 174. Stops a task. For more information, see stoptask on page 177. Stops a workflow. For more information, see stopworkflow on page 179. Removes a workflow from the schedule. For more information, see unscheduleworkflow on page 181.
getworkflowdetails
Command line, Interactive Command line, Interactive Command line, Interactive Command line, Interactive Command line, Interactive
help pingservice recoverworkflow scheduleworkflow
setfolder
Interactive
setnowait
Interactive
setwait
Interactive
showsettings
Interactive
startask startworkflow stoptask stopworkflow unscheduleworkflow
Command line, Interactive Command line, Interactive Command line, Interactive Command line, Interactive Command line, Interactive
pmcmd Commands
141
Table 5-3. pmcmd Commands Command unsetfolder version waittask Modes Interactive Command line, Interactive Command line, Interactive Command line, Interactive Description Designates no folder as the default folder. For more information, see unsetfolder on page 183. Displays the PowerCenter version number. For more information, see version on page 184. Instructs the Integration Service to wait for the completion of a running task before starting another command. For more information, see waittask on page 185. Notifies you whether the workflow ran successfully or is not running. For more information, see waitworkflow on page 187.
waitworkflow
142
aborttask
Aborts a task. Issue this command only if the Integration Service fails to stop the task when you issue the stoptask command. For more information about stopping and aborting tasks, see Working with Workflows in the Workflow Administration Guide. The aborttask command uses the following syntax in the command line mode:
pmcmd aborttask <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow [-wait|-nowait] taskInstancePath
The aborttask command uses the following syntax in the interactive mode:
aborttask [<-folder|-f> folder] <-workflow|-w> workflow [-wait|-nowait] taskInstancePath
Table 5-4 lists pmcmd aborttask options and arguments:

Table 5-4. aborttask Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u -uservar -uv
username
Conditional
userEnvVar
Conditional
aborttask
143
Table 5-4. aborttask Options and Arguments Option -password -p Argument password Required/ Optional Conditional Description Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task. Required if the task name is not unique in the repository. Name of the workflow. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
-passwordvar -pv -folder -f -workflow -w -wait -nowait
passwordEnvVar
Conditional
folder workflow n/a
Conditional Required Optional
n/a
taskInstancePath
Required
144
abortworkflow
Aborts a workflow. Issue this command only if the Integration Service fails to stop the workflow when you issue the stopworkflow command. For more information about how the Integration Service aborts and stops workflows, see Working with Workflows in the Workflow Administration Guide. The abortworkflow command uses the following syntax in the command line mode:
pmcmd abortworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] [-wait|-nowait] workflow
The abortworkflow command uses the following syntax in the interactive mode:
abortworkflow [<-folder|-f> folder] [-wait|-nowait] workflow
Table 5-5 lists pmcmd abortworkflow options and arguments:

Table 5-5. abortworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
abortworkflow
145
Table 5-5. abortworkflow Options and Arguments Option -password -p Argument password Required/ Optional Conditional Description Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Name of the workflow.
-passwordvar -pv -folder -f -wait -nowait
passwordEnvVar
Conditional
folder n/a
Conditional Optional
n/a
workflow
Required
146
connect
Connects the pmcmd program to the Integration Service in the interactive mode. If you omit connection information, pmcmd prompts you to enter the correct information. Once pmcmd successfully connects, you can issue commands without reentering the connection information.
connect <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
Note: Use this command in the pmcmd interactive mode only.
Table 5-6 lists pmcmd connect options and arguments:

Table 5-6. connect Options and Arguments Option -service -sv -domain -d -timeout -t Argument service domain timeout Required/ Optional Required Optional Optional Description Integration Service name. Domain name. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required if you do not specify the user name environment variable. Specifies the user name environment variable. Required if you do not specify the user name. Repository password. Required if you do not specify the password environment variable. Password environment variable. Required if you do not specify the password.
-user -u -uservar -uv -password -p -passwordvar -pv
username
Conditional
userEnvVar password
Conditional Conditional
passwordEnvVar
Conditional
connect
147
disconnect
Disconnects pmcmd from the Integration Service. It does not close the pmcmd program. Use this command when you want to disconnect from an Integration Service and connect to another in the interactive mode. The disconnect command uses the following syntax in the interactive mode:
disconnect
148
exit
Disconnects pmcmd from the Integration Service and closes the pmcmd program. The exit command uses the following syntax in the interactive mode:
exit
exit
149
getrunningsessionsdetails
Returns the following details for all sessions currently running on an Integration Service:

Integration Service status, startup time, and current time Folder and workflow name Worklet and session instance For each running session: task type, start time, run status, first error code, associated Integration Service, run mode, and node name For the mapping in a running session: mapping name, session log file, first error code and error message, number of source and target success and failed rows, and number of transformation error messages Number of sessions running on the Integration Service
The getrunningsessionsdetails command uses the following syntax in the command line mode:
pmcmd getrunningsessionsdetails <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
The getrunningsessionsdetails command uses the following syntax in the interactive mode:
Table 5-7 lists pmcmd getrunningsessionsdetails options and arguments:

Table 5-7. getrunningsessionsdetails Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
150
Table 5-7. getrunningsessionsdetails Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode.
password
Conditional
-passwordvar -pv
passwordEnvVar
Conditional
151
getservicedetails
Returns the following details about an Integration Service:

Integration Service name, status, startup time, and current time For each active workflow: folder name, workflow name, version, run status, first error code, start time, log file, run type, user that runs the workflow For each active task: folder name, workflow name and version, task instance name and version, task type, start and end time, run status, first error code, error message, associated Integration Service, run mode, names of nodes where the task runs Number of scheduled, active, and waiting workflows and sessions
The getservicedetails command uses the following syntax in the command line mode:
pmcmd getservicedetails <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [-all|-running|-scheduled]
The getservicedetails command uses the following syntax in the interactive mode:
getservicedetails [-all|-running|-scheduled]
Table 5-8 lists pmcmd getservicedetails options and arguments:

Table 5-8. getservicedetails Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
152
Table 5-8. getservicedetails Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Specifies the workflows to return details for: - all. Returns status details on the scheduled and running workflows. - running. Returns status details on active workflows. Active workflows include running, suspending, and suspended workflows. - scheduled. Returns status details on the scheduled workflows. Default is all.
password
Conditional
-passwordvar -pv -all -running -scheduled
passwordEnvVar
Conditional
n/a
Optional
getservicedetails
153
Returns the following information about the Integration Service:

Domain in which the Integration Service runs Integration Service name and version Whether the Integration Service allows running debug mappings Data movement mode Associated repository service Current timestamp and startup time Server grid name Names, nodes, and code pages for the associated Integration Service processes
The getserviceproperties command uses the following syntax in the command line mode:
pmcmd getserviceproperties <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
The getserviceproperties command uses the following syntax in the interactive mode:
Table 5-9 lists pmcmd getserviceproperties options and arguments:

Table 5-9. getserviceproperties Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180.
domain
Conditional
timeout
Conditional
154
Returns session details and statistics. The command returns the following information:

Folder name, workflow name, worklet or session instance, and mapping name Session log file name and location Number of source and target success and failure rows Number of transformation errors First error code and error message Task run status Name of associated Integration Service Grid and node names where the session runs Partition name For each transformation within a partition: transformation instance, transformation name, number of applied, affected, and rejected rows, throughput, last error code, start and end time
The command also returns the following information for each partition:

The getsessionstatistics command uses the following syntax in the command line mode:
pmcmd getsessionstatistics <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
The getsessionstatistics command uses the following syntax in the interactive mode:
getsessionstatistics [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
Table 5-10 lists pmcmd getsessionstatistics options and arguments:

Table 5-10. getsessionstatistics Options and Arguments Option -service -sv -domain -d Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode.
domain
Conditional
155
Table 5-10. getsessionstatistics Options and Arguments Option -timeout -t Argument timeout Required/ Optional Conditional Description Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task Required if the task name is not unique in the repository. Name of the workflow. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
-user -u -uservar -uv -password -p
username
Conditional
userEnvVar
Conditional
password
Conditional
-passwordvar -pv -folder -f -workflow -w n/a
passwordEnvVar
Conditional
folder workflow taskInstancePath
Conditional Required Required
156
gettaskdetails
Returns the following information about a task:

Folder name, workflow name, task instance name, and task type Last execution start and complete time Task run status, first error code, and error message Grid and node names where the task runs Name of associated Integration Service Task run mode Mapping and session log file name First error code and message Source and target success and failed rows Number of transformation errors
If the task is a session, the command also returns the following details:

The gettaskdetails command uses the following syntax in the command line mode:
pmcmd gettaskdetails <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
The gettaskdetails command uses the following syntax in the interactive mode:
gettaskdetails [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
Table 5-11 lists pmcmd gettaskdetails options and arguments:

Table 5-11. gettaskdetails Options and Arguments Option -service -sv -domain -d Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode.
domain
Conditional
gettaskdetails
157
Table 5-11. gettaskdetails Options and Arguments Option -timeout -t Argument timeout Required/ Optional Conditional Description Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task. Required if the task name is not unique in the repository. Name of the workflow. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
username
Conditional
userEnvVar
Conditional
password
Conditional
passwordEnvVar
Conditional
158
getworkflowdetails
Returns the following information about a workflow:

Folder and workflow names Workflow run status First error code and error message Start and end times Log file name Workflow run type Name of user that last ran the workflow Name of associated Integration Service
The getworkflowdetails command uses the following syntax in the command line mode:
pmcmd getworkflowdetails <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] workflow
The getworkflowdetails command uses the following syntax in the interactive mode:
getworkflowdetails [<-folder|-f> folder] workflow
Table 5-12 lists pmcmd getworkflowdetails options and arguments:

Table 5-12. getworkflowdetails Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180.
domain
Conditional
timeout
Conditional
getworkflowdetails
159
Table 5-12. getworkflowdetails Options and Arguments Option -user -u -uservar -uv -password -p Argument username Required Optional Conditional Description Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Name of the workflow.
userEnvVar
Conditional
password
Conditional
-passwordvar -pv -folder -f n/a
passwordEnvVar
Conditional
folder workflow
Conditional Required
160
help
Returns the syntax for the command you specify. If you omit the command name, pmcmd lists all commands and their syntax. The help command uses the following syntax in the command line mode:
pmcmd help [command]
The help command uses the following syntax in the interactive mode:
help [command]
Table 5-13 lists pmcmd help options and arguments:

Table 5-13. help Options and Arguments Option n/a Argument command Required/ Optional Optional Description Name of command. If you omit the command name, pmcmd lists all commands and their syntax.
help
161
pingservice
Verifies that the Integration Service is running. The pingservice command uses the following syntax in the command line mode:
pmcmd pingservice <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
The pingservice command uses the following syntax in the interactive mode:
pingservice
Table 5-14 lists pmcmd pingservice options and arguments:

Table 5-14. pingservice Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180.
domain
Conditional
timeout
Conditional
162
recoverworkflow
Recovers suspended workflows. To recover a workflow, specify the folder and workflow name. The Integration Service recovers the workflow from all suspended and failed worklets and all suspended and failed Command, Email, and Session tasks. The recoverworkflow command uses the following syntax in the command line mode:
pmcmd recoverworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] [<-paramfile> paramfile] [<-localparamfile|-lpf> localparamfile] [-wait|-nowait] workflow
The recoverworkflow command uses the following syntax in the interactive mode:
recoverworkflow [<-folder|-f> folder] [<-paramfile> paramfile] [<-localparamfile|-lpf> localparamfile] [-wait|-nowait] workflow
Table 5-15 lists pmcmd recoverworkflow options and arguments:

Table 5-15. recoverworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
recoverworkflow
163
Table 5-15. recoverworkflow Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Determines which parameter file to use when a task or workflow runs. It overrides the configured parameter file for the workflow or task. Specifies the parameter file on a local machine that pmcmd uses when you start a workflow. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Name of the workflow.
password
Conditional
-passwordvar -pv -folder -f -paramfile
passwordEnvVar
Conditional
folder paramfile
-localparamfile -lpf -wait -nowait
localparamfile n/a
Optional Optional
n/a
workflow
Required
164
scheduleworkflow
Instructs the Integration Service to schedule a workflow. Use this command to reschedule a workflow that has been removed from the schedule. The scheduleworkflow command uses the following syntax in the command line mode:
pmcmd scheduleworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] workflow
The scheduleworkflow command uses the following syntax in the interactive mode:
scheduleworkflow [<-folder|-f> folder] workflow
Table 5-16 lists pmcmd scheduleworkflow options and arguments:

Table 5-16. scheduleworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
password
Conditional
scheduleworkflow
165
Table 5-16. scheduleworkflow Options and Arguments Option -passwordvar -pv -folder -f n/a Argument passwordEnvVar Required/ Optional Conditional Description Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Name of the workflow.
folder workflow
166
setfolder
Designates a folder as the default folder in which to execute all subsequent commands. After issuing this command, you do not need to enter a folder name for workflow, task, and session commands. If you enter a folder name in a command after the setfolder command, that folder name overrides the default folder name for that command only. The setfolder command uses the following syntax in the interactive mode:
setfolder folder
Table 5-17 lists pmcmd setfolder option and argument:

Table 5-17. setfolder Option and Argument Option n/a Argument folder Required/ Optional Required Description Name of the folder.
setfolder
167
setnowait
You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt after the command completes. You cannot run subsequent commands until the previous command completes. In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to wait for one command to complete before running the next command. For more information about wait and nowait modes, see Running in Wait Mode on page 137. The setnowait command runs pmcmd in nowait mode. The nowait mode is the default mode. The setnowait command uses the following syntax in the interactive mode:
setnowait
When you set nowait mode, use the pmcmd prompt after the Integration Service executes the previous command.
168
setwait
You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt after the command completes. You cannot run subsequent commands until the previous command completes. In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to wait for one command to complete before running the next command. For more information about wait and nowait modes, see Running in Wait Mode on page 137. The setwait command runs pmcmd in wait mode. The pmcmd prompt is available after the Integration Service completes the previous command. The setwait command uses the following syntax in the interactive mode:
setwait
setwait
169
showsettings
Returns the name of the domain, Integration Service, and repository to which pmcmd is connected. It displays the user name, wait mode, and default folder. The showsettings command uses the following syntax in the interactive mode:
showsettings
170
starttask
Starts a task. The starttask command uses the following syntax in the command line mode:
pmcmd starttask <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow [<-paramfile> paramfile] [-wait|-nowait] [<-recovery>] taskInstancePath
The starttask command uses the following syntax in the interactive mode:
starttask [<-folder|-f> folder] <-workflow|-w> workflow [<-paramfile> paramfile] [-wait|-nowait] [<-recovery>] taskInstancePath
Table 5-18 lists pmcmd starttask options and arguments:

Table 5-18. starttask Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
starttask
171
Table 5-18. starttask Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task. Required if the task name is not unique in the repository. Name of the workflow. Determines which parameter file to use when a task or workflow runs. It overrides the configured parameter file for the workflow or task. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. If the task is a session, runs the session based on the configured recovery strategy. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
password
Conditional
-passwordvar -pv -folder -f -workflow -w -paramfile
passwordEnvVar
Conditional
folder workflow paramfile
-wait -nowait
n/a
Optional
-recovery n/a
n/a taskInstancePath
Optional Required
Using Parameter Files with starttask

When you start a task, you can optionally enter the directory and name of a parameter file. The Integration Service runs the task using the parameters in the file you specify. For UNIX shell users, enclose the parameter file name in single quotes:
-paramfile '$PMRootDir/myfile.txt'
For Windows command prompt users, the parameter file name cannot have beginning or trailing spaces. If the name includes spaces, enclose the file name in double quotes:
-paramfile "$PMRootDir\my file.txt"
172
When you write a pmcmd command that includes a parameter file located on another machine, use the backslash (\) with the dollar sign ($). This ensures that the machine where the variable is defined expands the process variable.
pmcmd starttask -sv MyIntService -d MyDomain -uv USERNAME -pv PASSWORD -f east -w wSalesAvg -paramfile '\$PMRootDir/myfile.txt' taskA
starttask
173
startworkflow
Starts a workflow. The startworkflow command uses the following syntax in the command line mode:
pmcmd startworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] [<-startfrom> taskInstancePath [<-recovery>]] [<-paramfile> paramfile] [<-localparamfile|-lpf> localparamfile] [-wait|-nowait] workflow
The startworkflow command uses the following syntax in the interactive mode:
startworkflow [<-folder|-f> folder] [<-startfrom> taskInstancePath [<-recovery>]] [<-paramfile> paramfile] [<-localparamfile|-lpf> localparamfile] [-wait|-nowait] workflow
Table 5-19 lists pmcmd startworkflow options and arguments:

Table 5-19. startworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
174
Table 5-19. startworkflow Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Starts a workflow from a specified task, taskInstancePath. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string. If you do not specify a starting point, the workflow starts at the Start task. If the task is a session, specify -recovery to run the session based on the configured recovery strategy. Determines which parameter file to use when a task or workflow runs. It overrides the configured parameter file for the workflow or task. Specifies the parameter file on a local machine that pmcmd uses when you start a workflow. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Name of the workflow.
password
Conditional
-passwordvar -pv -folder -f -startfrom
passwordEnvVar
Conditional
folder taskInstancePath, -recovery
-paramfile
paramfile
Optional
-localparamfile -lpf -wait -nowait
localparamfile n/a
Optional Optional
n/a
workflow
Required
Using Parameter Files with startworkflow

When you start a workflow, you can optionally enter the directory and name of a parameter file. The Integration Service runs the workflow using the parameters in the file you specify. For UNIX shell users, enclose the parameter file name in single quotes. For Windows command prompt users, the parameter file name cannot have beginning or trailing spaces. If the name includes spaces, enclose the file name in double quotes. Use parameter files on the following machines:
startworkflow
175
Node running the Integration Service. When you use a parameter file located on the Integration Service machine, use the -paramfile option to indicate the location and name of the parameter file. On UNIX, use the following syntax:
-paramfile '$PMRootDir/myfile.txt'
On Windows, use the following syntax:

-paramfile "$PMRootDir\my file.txt"
Local machine. When you use a parameter file located on the machine where pmcmd is invoked, pmcmd passes variables and values in the file to the Integration Service. When you list a local parameter file, specify the absolute path or relative path to the file. Use the -localparamfile or -lpf option to indicate the location and name of the local parameter file. On UNIX, use the following syntax:
-lpf 'param_file.txt' -lpf 'c:\Informatica\parameterfiles\param file.txt' -localparamfile 'c:\Informatica\parameterfiles\param file.txt'
On Windows, use the following syntax:

-lpf param_file.txt -lpf "c:\Informatica\parameterfiles\param file.txt -localparamfile param_file.txt
Shared network drives. When you use a parameter file located on another machine, use the backslash (\) with the dollar sign ($). This ensures that the machine where the variable is defined expands the process variable.
-paramfile '\$PMRootDir/myfile.txt'
176
stoptask
Stops a task. The stoptask command uses the following syntax in the command line mode:
pmcmd stoptask <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow [-wait|-nowait] taskInstancePath
The stoptask command uses the following syntax in the interactive mode:
stoptask [<-folder|-f> folder] <-workflow|-w> workflow [-wait|-nowait] taskInstancePath
Table 5-20 lists pmcmd stoptask options and arguments:

Table 5-20. stoptask Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
stoptask
177
Table 5-20. stoptask Options and Arguments Option -password -p Argument password Required/ Optional Conditional Description Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task. Required if the task name is not unique in the repository. Name of the workflow. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
-passwordvar -pv -folder -f -workflow -w -wait -nowait
passwordEnvVar
Conditional
folder workflow n/a
n/a
taskInstancePath
Required
178
stopworkflow
Stops a workflow. The stopworkflow command uses the following syntax in the command line mode:
pmcmd stopworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] [-wait|-nowait] workflow
The stopworkflow command uses the following syntax in the interactive mode:
stopworkflow [<-folder|-f> folder] [-wait|-nowait] workflow
Table 5-21 lists pmcmd stopworkflow options and arguments:

Table 5-21. stopworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
password
Conditional
stopworkflow
179
Table 5-21. stopworkflow Options and Arguments Option -passwordvar -pv -folder -f -wait -nowait Argument passwordEnvVar Required/ Optional Conditional Description Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Configures the wait mode: - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command. - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command. Default is nowait. For more information, see Running in Wait Mode on page 137. Name of the workflow.
folder n/a
n/a
workflow
Required
180
unscheduleworkflow
Removes a workflow from a schedule. The unscheduleworkflow command uses the following syntax in the command line mode:
pmcmd unscheduleworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] workflow
The unscheduleworkflow command uses the following syntax in the interactive mode:
unscheduleworkflow [<-folder|-f> folder] workflow
Table 5-22 lists pmcmd unscheduleworkflow options and arguments:

Table 5-22. unscheduleworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
password
Conditional
unscheduleworkflow
181
Table 5-22. unscheduleworkflow Options and Arguments Option -passwordvar -pv -folder -f n/a Argument passwordEnvVar Required/ Optional Conditional Description Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Name of the workflow.
folder workflow
182
unsetfolder
Removes the designation of a default folder. After you issue this command, you must specify a folder name each time you enter a command for a session, workflow, or task. The unsetfolder command uses the following syntax in the interactive mode:
unsetfolder
unsetfolder
183
version
Displays the PowerCenter version and Informatica trademark and copyright information. The version command uses the following syntax in the command line mode:
pmcmd version
The version command uses the following syntax in the interactive mode:
version
184
waittask
Instructs the Integration Service to complete the task before returning the pmcmd prompt to the command prompt or shell. The waittask command uses the following syntax in the command line mode:
pmcmd waittask <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
The waittask command uses the following syntax in the interactive mode:
waittask [<-folder|-f> folder] <-workflow|-w> workflow taskInstancePath
Table 5-23 lists pmcmd waittask options and arguments:

Table 5-23. waittask Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode. Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode.
domain
Conditional
timeout
Conditional
username
Conditional
userEnvVar
Conditional
waittask
185
Table 5-23. waittask Options and Arguments Option -password -p Argument password Required/ Optional Conditional Description Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the task. Required if the task name is not unique in the repository. Name of the workflow. Specifies a task name and where it appears within the workflow. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string.
passwordEnvVar
Conditional
186
waitworkflow
Causes pmcmd to wait for a workflow to complete before it executes subsequent commands. Use this command in conjunction with the return code when you run pmcmd from a script. For example, you may want to check the status of a critical workflow before starting another workflow. Use the waitworkflow command to wait for the critical workflow to complete, and then check the pmcmd return code. If the return code is 0 (successful), start the next workflow. For more information about pmcmd return codes, see Return Codes on page 135. The waitworkflow command returns the prompt when a workflow completes. The waitworkflow command uses the following syntax in the command line mode:
pmcmd waitworkflow <<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]> <<-user|-u> username|<-uservar|-uv> userEnvVar> <<-password|-p> password|<-passwordvar|-pv> passwordEnvVar> [<-folder|-f> folder] workflow
The waitworkflow command uses the following syntax in the interactive mode:
waitworkflow [<-folder|-f> folder] workflow
Table 5-24 lists pmcmd waitworkflow options and arguments:

Table 5-24. waitworkflow Options and Arguments Option -service -sv -domain -d -timeout -t Argument service Required/ Optional Conditional Description Integration Service name. Required in command line mode. Not used in interactive mode. Domain name. Optional in command line mode. Not used in interactive mode. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. Optional in command line mode. Not used in interactive mode. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. Repository user name. Required in command line mode if you do not specify the user name environment variable. Not used in interactive mode.
domain
Conditional
timeout
Conditional
-user -u
username
Conditional
waitworkflow
187
Table 5-24. waitworkflow Options and Arguments Option -uservar -uv -password -p Argument userEnvVar Required/ Optional Conditional Description Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. Repository password. Required in command line mode if you do not specify the password environment variable. Not used in interactive mode. Password environment variable. Required in command line mode if you do not specify the password. Not used in interactive mode. Name of the folder containing the workflow. Required if the workflow name is not unique in the repository. Name of the workflow.
password
Conditional
-passwordvar -pv -folder -f n/a
passwordEnvVar
Conditional
folder workflow
188
Chapter 6
pmrep Commands Reference


Using pmrep, 190 pmrep Commands, 194
189
Using pmrep
pmrep is a command line program that you use to update repository information and perform repository functions. pmrep is installed in the PowerCenter Client and PowerCenter Services bin directories. Use pmrep to perform repository administration tasks such as listing repository objects, creating and editing groups, restoring and deleting repositories, and updating session-related parameters and security information in the PowerCenter repository. When you use pmrep, you can enter commands in the following modes:

Command line mode. You can issue pmrep commands directly from the system command line. Use command line mode to script pmrep commands. Interactive mode. You can issue pmrep commands from an interactive prompt. pmrep does not exit after it completes a command.
You can use environment variables to set repository user names and passwords for pmrep. Before you use pmrep, configure these variables. For more information, see Configuring Environment Variables on page 5. All pmrep commands require a connection to the repository except for the following commands:

Help ListAllPrivileges
Use the pmrep Connect command to connect to the repository before using other pmrep commands.
Running Commands in Command Line Mode

Command line mode invokes and exits pmrep each time you issue a command. Command line mode is useful if you want to run pmrep commands through batch files, scripts, or other programs. For more information about scripting pmrep commands, see Scripting pmrep Commands on page 192.
To run pmrep commands in command line mode: 1. 2.
At the command prompt, change to the directory where the pmrep executable is located. Enter pmrep followed by the command name and its options and arguments:
pmrep command_name [-option1] argument_1 [-option2] argument_2...
Running Commands in Interactive Mode

Interactive mode invokes pmrep. You can issue a series of commands from a pmrep prompt without exiting after each command.
190
Chapter 6: pmrep Commands Reference
To run pmrep commands in interactive mode: 1.
At the command prompt, enter pmrep to invoke interactive mode. This starts pmrep in interactive mode and displays a pmrep> prompt. You do not have to type pmrep before each command in interactive mode.
2.
Enter a command and its options and arguments. At the prompt, enter:
command_name [-option1] argument_1 [-option2] argument_2...
pmrep runs the command and displays the prompt again.

3.
Type exit to end an interactive session.
Running Commands in Normal Mode and Exclusive Mode

The Repository Service runs in normal or exclusive mode. Run the Repository Service in exclusive mode to perform tasks that permit only one user connection to the repository. Run the Repository Service in exclusive mode to use the following pmrep commands:

Create Delete Register RegisterPlugin Unregister UnregisterPlugin
You can use the Administration Console or infacmd to run the Repository Service in exclusive mode. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about updating the Repository Service with infacmd, see UpdateRepositoryService on page 107.
Return Codes
pmrep indicates the success or failure of a command with a return code. Return code (0) indicates that the command succeeded. Return code (1) indicates that the command failed. Enter one of the following DOS or UNIX echo commands immediately after running the pmrep command:

In a DOS shell, enter echo %ERRORLEVEL% In a UNIX Bourne or Korn shell, enter echo $? In a UNIX C shell, enter echo $status
Using pmrep
191
Using Native Connect Strings

Some pmrep commands, such as CreateConnection and Restore, require a native connect string. Table 6-1 lists the native connect string syntax for each supported repository database:
Table 6-1. Native Connect String Syntax Database IBM DB2 Microsoft SQL Server Oracle Sybase ASE Connect String Syntax dbname servername@dbname dbname.world (same as TNSNAMES entry) servername@dbname Example mydatabase sqlserver@mydatabase oracle.world sambrown@mydatabase
Scripting pmrep Commands

When you use pmrep, you might use some commands with specific options and arguments on a regular basis. For example, you might use pmrep to perform a daily backup of a production repository. In this case, you can create a script file to call one or more pmrep commands including its options and arguments. For example, the following Windows batch file, backupproduction.bat, connects to and backs up a repository called Production:
backupproduction.bat REM This batch file uses pmrep to connect to and back up the repository Production on the server ServerName @echo off echo Connecting to repository Production... c:\PowerCenter\pmrep\pmrep connect -r Production -n Administrator -x Adminpwd -d MyDomain -h Machine -o 8080 echo Backing up repository Production... c:\PowerCenter\pmrep\pmrep backup -o c:\backup\Production_backup.rep
You can run script files from the command interface. You cannot run pmrep batch files in interactive mode.
Tips
Use the following tips when you create and run pmrep scripts:

Include a Connect command as the first command called by the script file. This helps ensure that you perform tasks on the correct repository. To run pmrep scripts that connect to different repositories simultaneously, set the INFA_REPCNX_INFO environment variable in each environment to store the name and file path for the repository connection file. This prevents a script from overwriting the
192
connection information used by another script. For more information, see INFA_REPCNX_INFO on page 14.
Using pmrep
193
pmrep Commands
Table 6-2 provides descriptions of the pmrep commands. For more information about using pmrep commands, see Using pmrep on page 190.
Table 6-2. pmrep Commands Command AddPrivilege AddToDeploymentGroup AddUserToGroup ApplyLabel BackUp ChangePasswd CheckIn CleanUp ClearDeploymentGroup Connect Create CreateConnection CreateDeploymentGroup CreateFolder CreateGroup CreateLabel CreateUser Delete DeleteConnection DeleteDeploymentGroup Description Adds a privilege to a user or group. For more information, see AddPrivilege on page 198. Adds objects to a deployment group. For more information, see AddToDeploymentGroup on page 199. Adds a user to a group. For more information, see AddUserToGroup on page 201. Applies a label to an object or set of objects in a folder. For more information, see ApplyLabel on page 202. Backs up a repository. For more information, see BackUp on page 204. Changes the password for the user currently connected to the repository. For more information, see ChangePasswd on page 205. Checks in an object. For more information, see CheckIn on page 206. Cleans up persistent resources created by pmrep during a session. For more information, see CleanUp on page 207. Clears all objects from a deployment group. For more information, see ClearDeploymentGroup on page 208. Connects to the repository. For more information, see Connect on page 209. Creates repository tables in the database. For more information, see Create on page 211. Creates a relational connection. For more information, see CreateConnection on page 212. Creates a deployment group. For more information, see CreateDeploymentGroup on page 217. Creates a folder. For more information, see CreateFolder on page 218. Creates a group. For more information, see CreateGroup on page 220. Creates a label object. For more information, see CreateLabel on page 221. Creates a user. For more information, see CreateUser on page 222. Deletes the repository tables from the database. For more information, see Delete on page 223. Deletes an existing relational connection. For more information, see DeleteConnection on page 224. Deletes a deployment group. For more information, see DeleteDeploymentGroup on page 225.
194
Table 6-2. pmrep Commands Command DeleteFolder DeleteLabel DeployDeploymentGroup DeployFolder EditUser ExecuteQuery Exit FindCheckout Help KillUserConnection ListAllGroups ListAllPrivileges ListAllUsers ListGroupsForUser ListObjectDependencies ListObjects ListTablesBySess ListUserConnections LsPrivileges ModifyFolder Notify ObjectExport ObjectImport Description Deletes a folder. For more information, see DeleteFolder on page 226. Deletes a label object and all object references to the label. For more information, see DeleteLabel on page 227. Copies a deployment group. For more information, see DeployDeploymentGroup on page 228. Deploys a folder. For more information, see DeployFolder on page 230. Edits the profile of a user. For more information, see EditUser on page 232. Executes a query. For more information, see ExecuteQuery on page 234. Exits from pmrep. For more information, see Exit on page 236. Prints a list of checked out objects in the repository. For more information, see FindCheckout on page 237. Displays help for all commands or for a specified command. For more information, see Help on page 239. Terminates user connection to the repository. For more information, see KillUserConnection on page 240. Lists all groups registered with the repository. For more information, see ListAllGroups on page 241. Lists all privileges that you can assign to a user or group. For more information, see ListAllPrivileges on page 242. Lists all users registered with the repository. For more information, see ListAllUsers on page 243. Lists all groups that the user belongs to. For more information, see ListGroupsForUser on page 244. Lists dependent objects. For more information, see ListObjectDependencies on page 245. Lists objects in the repository. For more information, see ListObjects on page 248. Lists sources or targets in a session. For more information, see ListTablesBySess on page 254. Lists user connections to the Repository Service. For more information, see ListUserConnections on page 256. Lists the privileges granted to a user or group. For more information, see LsPrivileges on page 257. Modifies folder properties. For more information, see ModifyFolder on page 258. Sends notification messages. For more information, see Notify on page 259. Exports objects to an XML file. For more information, see ObjectExport on page 260. Imports objects from an XML file. For more information, see ObjectImport on page 262.
pmrep Commands
195
Table 6-2. pmrep Commands Command Register RegisterPlugin RegisterUser Restore RmGroup RmPrivilege RmUser RmUserFromGroup Run ShowConnectionInfo SwitchConnection TruncateLog UndoCheckout Unregister UnregisterPlugin UpdateConnection UpdateEmailAddr UpdateSeqGenVals UpdateSrcPrefix UpdateStatistics Description Registers local repositories with global repositories. For more information, see Register on page 263. Registers a new external module to the repository. For more information, see RegisterPlugin on page 265. Registers a user from an external directory service to access the Repository. For more information, see RegisterUser on page 267. Restores a repository from a repository backup file. For more information, see Restore on page 268. Removes a group from the repository. For more information, see RmGroup on page 271. Removes a privilege from a user or group. For more information, see RmPrivilege on page 272. Removes a user from the repository. For more information, see RmUser on page 273. Removes a user from a group. For more information, see RmUserFromGroup on page 274. Displays messages stating whether a run has completed or failed. For more information, see Run on page 275. Shows repository name, server, port and user information for the current connection. For more information, see ShowConnectionInfo on page 276. Changes the name of an existing connection. For more information, see SwitchConnection on page 277. Truncates log details from repository level, folder level, or workflow level. For more information, see TruncateLog on page 278. Undoes an object check out, releases the lock, and reverts to the last checked in version. For more information, see UndoCheckout on page 279. Unregisters local repositories from global repositories. For more information, see Unregister on page 280. Unregisters a plug-in module from the repository. For more information, see UnregisterPlugin on page 282. Changes user name, password, and connect string for a connection. For more information, see UpdateConnection on page 284. Updates the session notification email addresses. For more information, see UpdateEmailAddr on page 286. Updates transformation properties for Sequence Generator transformations. For more information, see UpdateSeqGenVals on page 287. Updates source table owner names. For more information, see UpdateSrcPrefix on page 289. Updates statistics for repository tables and indexes. For more information, see UpdateStatistics on page 291.
196
Table 6-2. pmrep Commands Command UpdateTargPrefix Upgrade Validate Version Description Updates target table name prefixes. For more information, see UpdateTargPrefix on page 292. Upgrades an existing repository to the latest version. For more information, see Upgrade on page 293. Validates objects. For more information, see Validate on page 294. Displays the PowerCenter version number. For more information, see Version on page 297.
pmrep Commands
197
AddPrivilege
Adds a privilege to a user or group. It cannot add a privilege to a user and a group at the same time. If you add a privilege to a group, all users in the group inherit the privilege. You must connect to the repository to use this command. To use the AddPrivilege command, you must have the Admin Repository privilege. The AddPrivilege command uses the following syntax:
addprivilege -p <privilege> {-u <repository_user_name> | -g <group_name>}
Table 6-3 lists pmrep AddPrivilege options and arguments:

Table 6-3. AddPrivilege Options and Arguments Option -p Argument privilege Required/ Optional Required Description Privilege you want to add. If the privilege name contains spaces, you must enclose this argument in quotes, such as Admin Repository. You can assign the following types of privileges: - Admin Repository - Admin Service - Browse Repository - Deploy - Manage Connection - Manage Deployment Group - Manage Folder - Manage Label - Super User - Use Designer - Use Repository Manager - Use Workflow Manager - Workflow Operator Name of the user to whom you want to add the privilege. If you use this option, you cannot use the -g option. Required if you do not use -g. Name of the group to which you want to add the privilege. If you use this option, you cannot use the -u option. Required if you do not use -u.
-u
repository_user_ name group_name
Conditional
-g
Conditional
198
AddToDeploymentGroup
Adds objects to a deployment group. Use AddToDeploymentGroup to add source, target, transformation, mapping, session, worklet, workflow, scheduler, session configuration, and task objects. You cannot add checked out objects to a deployment group. You can specify objects using command options or you can use a persistent input file. If you use a persistent input file, you can enter the deployment group name option. Use AddToDeploymentGroup to add reusable input objects. If you want to add non-reusable input objects, you must use a persistent input file that contains encoded object IDs. For more information about using a persistent input file, see Using the Persistent Input File on page 301. If AddToDeploymentGroup runs successfully, it either sends back no status information, or it returns a list of objects that are already in the deployment group. If the command fails, it displays the reason for failure. For more information about adding to a deployment group, see Working with Versioned Objects in the Repository Guide. To use the AddTo DeploymentGroup command, you must have the Use Repository Manager privilege and write permission on the folder. The AddToDeploymentGroup command uses the following syntax:
addtodeploymentgroup -p <deployment_group_name> {{-n <object_name> -o <object_type> -t <object_subtype>] [-v <version_number] [-f <folder_name>]} | [-i <persistent_input_file>]} [-d <dependency_types (all, "non-reusable", or none)>]
Table 6-4 lists pmrep AddToDeploymentGroup options and arguments:

Table 6-4. AddToDeploymentGroup Options and Arguments Option -p -n Argument deployment_group_name object_name Required/ Optional Required Conditional Description Name of the deployment group to add objects to. Name of the object you are adding to the deployment group. You must use this parameter when you add a specific object. You cannot enter the name of a checked out object. You cannot use the -n option if you use the -i option.
AddToDeploymentGroup
199
Table 6-4. AddToDeploymentGroup Options and Arguments Option -o Argument object_type Required/ Optional Conditional Description Type of object you are adding. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session configuration, task, cube, and dimension. Required when adding a specific object. Type of task or transformation you are adding. Required when using valid subtypes, see Table 6-36 on page 251. Version of the object to add. The default is to add the latest version of the object to the deployment group. Folder that contains the object you are adding. Required when you enter an object name. A text file generated from ExecuteQuery, Validate, or ListObjectDependencies that contains a list of object records with encoded IDs. If you use this parameter, pmrep does not allow the -n, -o, and -f options. For more information about using a persistent input file, see Overview on page 300. Dependent objects to add to the deployment group with the object. Enter one of the following: - all. pmrep adds the objects and all dependent objects, reusable and non-reusable, to the deployment group. - non-reusable. pmrep adds the objects and the corresponding non-reusable dependent objects to the deployment group. - none. pmrep does not add dependent objects to the deployment group. If you omit this parameter, pmrep adds the objects and all dependent objects to the deployment group. Note: Use double quotes around arguments that contain spaces or non-alphanumeric characters.
-t -v -f -i
object_subtype version_number folder_name persistent_input_file
Conditional Optional Conditional Conditional
-d
dependency_types
Optional
200
AddUserToGroup
Adds an existing user to a group. You must be connected to the repository to use this command. The user inherits all of the permissions and privileges associated with the group. To use the AddUserToGroup command, you must have the Admin Repository privilege. The AddUserToGroup command uses the following syntax:
addusertogroup -u <repository_user_name> -g <group_name>
Table 6-5 lists pmrep AddUserToGroup options and arguments:

Table 6-5. AddUserToGroup Options and Arguments Option -u -g Argument repository_user_name group_name Required/ Optional Required Required Description Name of the user to add to the group. Name of the group to which you want to add the user.
AddUserToGroup
201
ApplyLabel
Applies a label to an object or a set of objects in a folder. If you enter a folder name, all the objects in the folder receive the label. You can apply the label to dependent objects. If you use the dependency_object_types option, pmrep labels all dependent objects. To apply a label to selected dependent objects, separate each object type name by a comma with no spaces between them on the command line. Use ApplyLabel to label reusable input objects. If you want to label non-reusable input objects, you must use a persistent input file that contains encoded object IDs. For more information about using a persistent input file, see Using the Persistent Input File on page 301. If ApplyLabel succeeds, pmrep displays either no status information or a list of objects that already have the label. If the command fails, pmrep displays the reason for the failure. For more information about applying labels, see Working with Versioned Objects in the Repository Guide. To use the ApplyLabel command, you must have the Use Repository Manager privilege and read permission on the folder. The ApplyLabel command uses the following syntax:
applylabel -a <label_name> {{-n <object_name> -o <object_type> [-t <object_subtype>] [-v <version_number] [-f <folder_name>] } | -i <persistent_input_file>} [-d <dependency_object_types>] [-p <dependency_direction (children, parents, or both)>] [-s (include pk-fk dependency)] [-g (across repositories)] [-m (move label)] [-c <comments>]
Table 6-6 lists pmrep ApplyLabel options and arguments:

Table 6-6. ApplyLabel Options and Arguments Option -a -n Argument label_name object_name Required/ Optional Required Conditional Description Label name to apply to the object. Name of the object to receive the label. Required if you are updating a specific object. You cannot enter object names if you use the -i option.
202
Table 6-6. ApplyLabel Options and Arguments Option -o Argument object_type Required/ Optional Conditional Description Type of object to apply the label to. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, or dimension. Required when applying a label to a specific object. Type of task or transformation you are labeling. pmrep ignores other object types. For valid subtypes, see Table 6-36 on page 251. Version of the object to apply the label to. The command fails if the version is checked out. Applies the label to the latest version of the object by default. Folder that contains the objects. If you enter a folder name but no object name, pmrep applies the label to all objects in the folder. If you enter a folder name with an object name, pmrep searches the folder for the object. You cannot use the -f option if you use the -i option. Name of a text file generated from ExecuteQuery, ListObjectDependency, or Validate. Contains a list of objects to receive the label. If you use this option, do not use the object name, object type, or folder name to specify objects. For more information about using the persistent input file, see Overview on page 300. Dependent object types to label. Valid dependent object types include shortcuts, mappings, mapplets, sessions, workflows, worklets, target definitions, source definitions, and foreign key dependencies. Use this option with option -p. If you enter an object type, the label applies to dependent objects of that object type. Dependent parents or children to apply the label to. You can specify parents, children, or both. If you do not enter option -d, all dependent objects receive the label. If you do not enter this option, the label applies to the specified object. Include the primary key-foreign key dependency objects regardless of the direction of the dependency. Find object dependencies across repositories. Move a label from the current version to the latest version of an object. Use this argument when the label type is one_per_object. For more information, see CreateLabel on page 221. Comments about the label.
-t
object_subtype
Required
-v
version_number
Optional
-f
folder_name
Optional
-i
persistent_input_file
Optional
-d
dependency_object_types
Optional
-p
dependency_direction
Optional
-s -g -m
n/a n/a n/a
-c
comments
Optional
ApplyLabel
203
BackUp
Backs up the repository to the file specified with the -o option. You must provide the backup file name. Use this command when the repository is running. You must be connected to a repository to use this command. To use the BackUp command, you must have the Admin Repository privilege. The BackUp command uses the following syntax:
backup -o <output_file_name> [-d <description>] [-f (overwrite existing output file)] [-b (skip workflow and session logs)] [-j (skip deploy group history)] [-q (skip MX data)] [-v (skip task statistics)]
Table 6-7 lists pmrep BackUp options and arguments:

Table 6-7. Backup Options and Arguments Option -o -d Argument output_file_name description Required/ Optional Required Optional Description Name and path of the file for the repository backup. Creates a description of the backup file based on the string that follows the option. The backup process truncates any character beyond 2,000. Overwrites an existing file with the same name. Skips tables related to workflow and session logs during backup. Skips deployment group history during backup. Skips tables related to MX data during backup. Skips task statistics during backup.
-f -b -j -q -v
n/a n/a n/a n/a n/a
To restore the backup file, use the Administration Console, or use the pmrep Restore command. For more information about the pmrep Restore command, see Restore on page 268.
204
ChangePasswd
Changes the password of the user currently connected to the repository. You must connect to the repository and supply a user name to use this command.
Note: You cannot use this command with an external security module.
The ChangePasswd command uses the following syntax:

changepasswd [{-p <new_password> -c <confirm_password>}| -P <new_password_environment_variable>]
Table 6-8 lists pmrep ChangePasswd options and arguments:

Table 6-8. ChangePasswd Options and Arguments Option -p Argument new_password Required/ Optional Conditional Description Password that replaces the existing password for the current user. Use the -p or -P option, but not both. When you use the -p option, you must also use the -c option. Confirms the new password. The confirm_password argument must match the new_password argument. Required when you use the -p option. Password environment variable that replaces the existing password for the current user. Use the -p or -P option, but not both. When you use the -P option, do not use the -c option.
-c
confirm_password
Conditional
-P
new_password_env ironment_variable
Conditional
ChangePasswd
205
CheckIn
Checks in an object that you have checked out. When you check in an object, the repository creates a new version of the object and assigns it a version number. The version number is one number greater than the version number of the last checked-in version. For more information about checking in objects, see Working with Versioned Objects in the Repository Guide. To use the CheckIn command, you must have one of the following privileges and permission:

Use Repository Manager privilege (for object owner) with write permission on the folder Admin Repository privilege
The CheckIn command uses the following syntax:

checkin -o <object_type> [-t <object_subtype>] -n <object_name> -f <folder_name> [-c <comments>]
Table 6-9 lists pmrep CheckIn options and arguments:

Table 6-9. CheckIn Options and Arguments Option -o Argument object_type Required/ Optional Required Description Type of object you are checking in: source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, or dimension. Type of task or transformation to check in. Not required for other object types. For valid subtypes, see Table 6-36 on page 251. Name of the object that you are checking in. Folder to contain the new object version. Comments about the check in.
-t
object_subtype
Optional
-n -f -c
object_name folder_name comments
Required Required Optional
206
CleanUp
Cleans up any persistent resource created by pmrep. This command also cleans up any connection information from previous sessions of pmrep. Calling CleanUp as the first command in a session always returns an error. If you call CleanUp in the interactive mode, pmrep disconnects any repository you are connected to. The CleanUp command uses the following syntax:
cleanup
CleanUp
207
ClearDeploymentGroup
Clears all objects from a deployment group. Use this command to retain the deployment group but remove the objects. To use the ClearDeploymentGroup command, you must have the Use Repository Manager privilege and execute permission on the deployment group. The ClearDeploymentGroup command uses the following syntax:
cleardeploymentgroup -p <deployment_group_name> [-f (force clear)]
Table 6-10 lists pmrep ClearDeploymentGroup options and arguments:

Table 6-10. ClearDeploymentGroup Options and Arguments Option -p -f Argument deployment_group_name n/a Required/ Optional Required Optional Description Name of the deployment group that you want to clear. Remove objects without confirmation. If you omit this argument, the command prompts you for a confirmation before it clears the objects.
208
Connect
Connects to a repository. The first time you use pmrep in either command line or interactive mode, you must use the Connect command. All commands require a connection to the repository except for the following commands:

Exit Help ListAllPrivileges
In the command line mode, pmrep uses the information specified by the last call to connect to the repository. If pmrep is called without a successful connection, it returns an error. In command line mode, pmrep connects to and disconnects from the repository with every command. To use pmrep to perform tasks in multiple repositories in a single session, you must issue the Connect command each time you want to switch to a different repository. In the interactive mode, pmrep retains the connection until you exit pmrep or connect again. If you call Connect again, pmrep disconnects from the first repository and then connects to the second repository. If the second connection fails, the previous connection remains disconnected and you will not be connected to any repository. If you issue a command that requires a connection to the repository, and you are not connected to that repository, pmrep uses the connection information specified in the last successful connection made to the repository from any previous session of pmrep. pmrep retains information from the last successful connection until you use the Cleanup command. The Connect command uses the following syntax:
connect -r <repository_name> {-d <domain_name> | {-h <portal_host_name> -o <portal_port_number>}} [-n <repository_user_name> [-x <repository_password> | -X <repository_password_environment_variable>]] [-t <client_resilience>]
Table 6-11 lists pmrep Connect options and arguments:

Table 6-11. Connect Options and Arguments Option -r -d Argument repository_name domain_name Required/ Optional Required Conditional Description Name of the repository you want to connect to. Name of the domain for the repository. Required if you do not use -h and -o. If you use the -d option, do not use the -h and -o options. Gateway host name. Required if you do not use -d. If you use the -h option, then you must also use the -o option.
-h
portal_host_name
Conditional
Connect
209
Table 6-11. Connect Options and Arguments Option -o -n -x Argument portal_port_number repository_user_name repository_password Required/ Optional Conditional Optional Conditional Description Gateway port number. Required if you do not use -d. If you use the -o option, then you must also use the -h option. Repository user name used to connect to the repository. Password for the repository user name. The repository password is case-sensitive. Required if you use the -n option and you do not use the -X option. Use the -x or -X option, but not both. Password environment variable for the repository. Required if you use the -n option and you do not use the -x option. Use the -x or -X option, but not both. Amount of time in seconds that pmrep attempts to establish or reestablish a connection to the repository. If you omit the -t option, pmrep uses the timeout value specified in the INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no value is specified in the environment variable, the default of 180 seconds is used.
-X
repository_password_ environment_variable client_resilience
Conditional
-t
Optional
210
Create
Creates the repository tables in the database. Before you can create the repository tables, you must complete these tasks:
Create and configure the database to contain the repository. For more information about creating repositories, see Creating and Configuring the Repository Service in the Administrator Guide. Create the Repository Service in either the Administration Console or infacmd. For more information about creating a Repository Service using infacmd, see CreateRepositoryService on page 46. Run the Repository Service in exclusive mode in either the Administration Console or infacmd. For more information about changing the operating mode of a Repository Service, see UpdateRepositoryService on page 107. Connect to the repository in pmrep. For more information about using the Connect command, see Connect on page 209.
You cannot use the Create command if the repository database already contains repository tables. To use the Create command, you must have permission on the Repository Service in the domain. The Create command uses the following syntax:
create -u <domain_user_name> [-p <domain_password> | -P <domain_password_environment_variable>] [-g (create global repository)] [-v (enable object versioning)]
Table 6-12 lists pmrep Create options and arguments:

Table 6-12. Create Options and Arguments Option -u -p Argument domain_user_name domain_password Required/ Optional Required Optional Description Domain user name. Domain password. Use either the -p or -P option, but not both. If you do not use either the -p or -P option, pmrep prompts you to enter the domain password. Domain password environment variable. Use either the -p or -P option, but not both. If you do not use either the -p or -P option, pmrep prompts you to enter the domain password. Promotes the repository to a global repository. Enables object versioning for the repository.
-P
domain_password_ environment_variable
Optional
-g -v
n/a n/a
Optional Optional
Create
211
CreateConnection
Creates a source or target connection in the repository. The connection can be a relational or application connection. Relational database connections for each relational subtype require a subset of all CreateConnection options and arguments. For example, Oracle connections do not accept the -z, -d, or -t options. Use the -k option to specify attributes for application connections. To use the CreateConnection command, you must have the Manage Connection privilege. The CreateConnection command uses the following syntax:
createconnection -s <connection_type> -n <connection_name> -u <user_name> [-p <password> | -P <password_environment_variable>] [-c <connect string> (required for Oracle, Informix, DB2, and ODBC)] -l <code_page> [-r <rollback_segment> (valid for Oracle connection only)] [-e <connection_environment_SQL>] [-f <transaction_environment_SQL>] [-z <packet_size> (valid for Sybase ASE and MS SQL Server connection)] [-b <database_name> (valid for Sybase ASE, Teradata and MS SQL Server connection)] [-v <server_name> (valid for Sybase ASE and MS SQL Server connection)] [-d <domain name> (valid for MS SQL Server connection only)] [-t (enable_trusted_connection, valid for MS SQL Server connection only)] [-a <data_source_name> (valid for Teradata connection only)] [-x (enable advanced security, lets users give Read, Write and Execute permissions only for themselves.)] [-k <connection_attributes> (attributes have the format name=value;name=value; and so on)]
Table 6-13 lists pmrep CreateConnection options and arguments:

Table 6-13. CreateConnection Options and Arguments Option -s -n -u -p Argument connection_type connection_name user_name password Required/ Optional Required Required Required Optional Description Type of connection. For a list of valid database types, see Table 6-14 on page 214. Name of the connection. User name used for authentication when you connect to the relational database. Password used for authentication when you connect to the relational database. Use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the password.
212
Table 6-13. CreateConnection Options and Arguments Option -P Argument password_ environment_variable Required/ Optional Optional Description Password environment variable used for authentication when you connect to the relational database. Use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the password. Connect string the Integration Service uses to connect to the relational database. For a list of native connect strings, see Table 6-1 on page 192. Code page associated with the connection. For a list of valid code page IDs, see Table 6-15 on page 215. Valid for Oracle connections. The name of the rollback segment. A rollback segment records database transactions that allow you to undo the transaction. Enter SQL commands to set the database environment when you connect to the database. The Integration Service executes the connection environment SQL each time it connects to the database. Enter SQL commands to set the database environment when you connect to the database. The Integration Service executes the transaction environment SQL at the beginning of each transaction. Valid for Sybase ASE and Microsoft SQL Server connections. Optimizes the ODBC connection to Sybase ASE and Microsoft SQL Server. Name of the database. Valid for Sybase ASE and Microsoft SQL Server connections. Name of the database server. Valid for Sybase ASE and Microsoft SQL Server connections. Valid for Microsoft SQL Server connections. The name of the domain. Used for Microsoft SQL Server. Valid for Microsoft SQL Server connections. If enabled, the Integration Service uses Windows authentication to access the Microsoft SQL Server database. The user name that starts the Integration Service must be a valid Windows user with access to the Microsoft SQL Server database. Teradata ODBC data source name. Valid for Teradata connections.
-c
connect_string
Conditional
-l -r
code_page rollback_segment
Required Optional
-e
connection_environm ent_sql
Optional
-f
transaction_environm ent_sql
Optional
-z
packet_size
Optional
-b -v -d -t
database_name server_name domain_name n/a
-a
data_source_name
Required
CreateConnection
213
Table 6-13. CreateConnection Options and Arguments Option -x Argument n/a Required/ Optional Optional Description Enables enhanced security. Grants you read, write, and execute permissions. Public and world groups are not granted any permissions. If this option is not enabled, all groups and users are granted read, write, and execute permissions. For more information about enhanced security, see Managing Connection Objects in the Workflow Administration Guide. Enables user-defined connection attributes. Attributes have the format <name>=<value>;<name>=<value>; and so on.
-k
connection_attributes
Optional
Specifying Database Type

When you create a new connection, you must enter a database type using the string associated with that database type in pmrep. The strings are not case sensitive. Use quotes when entering a string with spaces in an argument. Table 6-14 lists the required pmrep database type strings according to database:
Table 6-14. Database Type Strings Database IBM DB2 Microsoft SQL Server ODBC Oracle Sybase ASE Database Type String DB2 Microsoft SQL Server ODBC Oracle Sybase ASE
Specifying Database Code Page Information

The -l option specifies the code page information for the database connection. To enter database code page information, you must use the string associated with the code page you want to assign to the database connection. Changing the database connection code page can cause data inconsistencies if the new code page is not compatible with the source or target database connection code pages. Also, if you configure the Integration Service for data code page validation, changing the database connection code page can cause sessions to fail if the source database connection code page is not a subset of the target database connection code page. For more information about data code page validation, see Understanding Globalization in the Administrator Guide. For a list of supported code pages and code page compatibility reference, see Code Pages in the Administrator Guide.
214
Table 6-15 lists the code page ID strings pmrep accepts to update database connection code page information:
Table 6-15. Code Page ID by Name Code Page Name 7-bit ASCII HITACHI KEIS Japanese HITACHI KEIS-Kana Japanese IBM EBCDIC Chinese (Simplified) IBM EBCDIC Chinese (Traditional) IBM EBCDIC French IBM EBCDIC German IBM EBCDIC International Latin-1 IBM EBCDIC Italian IBM EBCDIC Japanese IBM EBCDIC Japanese CP939 IBM EBCDIC UK English IBM EBCDIC US English ISO 8859-1 Western European ISO 8859-2 Eastern European ISO 8859-3 Southeast European ISO 8859-4 Baltic ISO 8859-5 Cyrillic ISO 8859-6 Arabic ISO 8859-7 Greek ISO 8859-8 Hebrew ISO 8859-9 Latin 5 (Turkish) ISO 8859-10 Latin 6 (Nordic) ISO 8859-15 Latin 9 (Western European) Japan Extended UNIX Code (incl. JIS x 0212) Japanese EBCDIC Fujitsu Japanese EBCDIC-Kana Fujitsu MITSUBISHI MELCOM Japanese MITSUBISHI MELCOM-Kana Japanese pmrep ID String US-ASCII KEIS KEIS-kana IBM935 IBM937 IBM297 IBM273 IBM500 IBM280 IBM930 IBM939 IBM285 IBM037 Latin1 ISO-8859-2 ISO-8859-3 ISO-8859-4 ISO-8859-5 ISO-8859-6 ISO-8859-7 ISO-8859-8 ISO-8859-9 ISO-8859-10 ISO-8859-15 JapanEUC JEF JEF-kana MELCOM MELCOM-kana
CreateConnection
215
Table 6-15. Code Page ID by Name Code Page Name MS-DOS Thai, superset of TIS 620 MS Windows Arabic MS Windows Baltic Rim MS Windows Chinese (Simplified), superset of GB 2312-80, EUC encoding MS Windows Chinese (Traditional), superset of Big 5 MS Windows Cyrillic (Slavic) MS Windows Greek MS Windows Hebrew MS Windows Japanese, superset of Shift-JIS MS Windows Korean superset of KS C 5601-1992 MS Windows Korean (Johab) MS Windows Latin 1 (ANSI), superset of Latin 2 MS Windows Latin 2 (Central Europe) MS Windows Latin 5 (Turkish), superset of ISO 8859-9 MS Windows Vietnamese NEC ACOS JIPSE Japanese NEC ACOS JIPSE-Kana Japanese UNISYS Japanese UNISYS-Kana Japanese UTF-8 encoding of Unicode pmrep ID String MS874 MS1256 MS1257 MS936 MS950 MS1251 MS1253 MS1255 MS932 MS949 MS1361 MS1252 MS1250 MS1254 MS1258 JIPSE JIPSE-kana UNISYS UNISYS-kana UTF-8
216
CreateDeploymentGroup
Creates a deployment group. You can create a dynamic or static deployment group. To create a dynamic deployment group, you must supply a query name, and indicate whether the query is private or public. For more information about creating deployment groups, see Working with Versioned Objects in the Repository Guide. To use the CreateDeploymentGroup command, you must have the Manage Deployment Group privilege. The CreateDeploymentGroup command uses the following syntax:
createdeploymentgroup -p <deployment_group_name> [-t <deployment_group_type (static or dynamic)>] [-q <query_name>] [-u <query_type (shared or personal)>] [-c <comments>]
Table 6-16 lists pmrep CreateDeploymentGroup options and arguments:

Table 6-16. CreateDeploymentGroup Options and Arguments Option -p -t Argument deployment_group_name deployment_group_type Required/ Optional Required Optional Description Name of the deployment group to create. Create a static group or use a query to dynamically create the group. You can specify static or dynamic. Default is static. Name of the query associated with the deployment group. Required if the deployment group is dynamic, but ignored if the group is static. Type of query to create a deployment group. You can specify shared or personal. Required if the deployment group is dynamic, but ignored if the group is static. Comments about the new deployment group.
-q
query_name
Conditional
-u
query_type
Conditional
-c
comments
Optional
CreateDeploymentGroup
217
CreateFolder
Creates a new folder in the repository. You cannot create a folder in a non-versioned repository. To use the CreateFolder command, you must have the Manage Folder privilege. The CreateFolder command uses the following syntax:
createfolder -n <folder_name> [-d <folder_description>] [-o <owner_name>] [-g <group_name>] [-s (shared_folder)] [-p <permissions>] [-f <active | frozendeploy | frozennodeploy>]
Table 6-17 lists pmrep CreateFolder options and arguments:

Table 6-17. CreateFolder Options and Arguments Option -n -d -o -g -s -p -f Argument folder_name folder_description owner_name group_name n/a permissions active frozendeploy frozennodeploy Required/ Optional Required Optional Optional Optional Optional Optional Optional Description New folder name. Description of the folder that displays in the Repository Manager. Owner of the folder. Any user in the repository can be the folder owner. Default owner is the user creating the folder. Repository user group to receive Owners Group permissions. Groups to which the owner belongs can be selected. Makes the folder shared. Access rights for the folder. If omitted, the Repository Service assigns default permissions. Change the folder status to one of the following status: - active. This status allows users to check out versioned objects in the folder. - frozendeploy (Frozen, Allow Deploy to Replace). This status prevents users from checking out objects in the folder. Deployment into the folder creates new versions of the objects. - frozennodeploy (Frozen, Do Not Allow Deploy to Replace). This status prevents users from checking out objects in the folder. You cannot deploy objects into this folder.
Assigning Permissions
You can assign owner, group, and repository permissions by entering three digits when you use the -p option. The first digit corresponds to owner permissions, the second corresponds to the permissions of the group that the user belongs to, and the third corresponds to all other permissions.
218 Chapter 6: pmrep Commands Reference
Enter one number for each set of permissions. Each permission is associated with a number. Designate 4 for read permission, 2 for write permission, and 1 for execute permission. To assign permissions, you enter 4, 2, 1, or the sum of any of those numbers. For example, if you want to assign default permissions, use the following command syntax:
-p 764
This gives the folder owner read, write, and execute permissions (7 = 4+2+1). The owners group has read and write permissions (6 = 4+2). All others have read permission. The command returns createfolder successfully completed or returns createfolder failed message. The creation might fail for the following reasons:

You do not have Manage Folder privilege. The folder already exists. The owner does not exist or does not belong to the group.
CreateFolder
219
CreateGroup
Adds a new group to the repository. pmrep creates the group with the default permissions and privileges assigned to the Public group. To use the CreateGroup command, you must have the Admin Repository privilege. The CreateGroup command uses the following syntax:
creategroup -g <group_name> [-d <description>]
Table 6-18 lists pmrep CreateGroup options and arguments:

Table 6-18. CreateGroup Options and Arguments Option -g -d Argument group_name description Required/ Optional Required Optional Description Name of the group you want to create. Description of the group you want to create.
220
CreateLabel
Creates a label that you use to associate groups of objects during development. You can associate a label with any versioned object or group of objects in a repository. For more information about creating labels, see Working with Versioned Objects in the Repository Guide. To use the CreateLabel command, you must have the Manage Label privilege. The CreateLabel command uses the following syntax:
createlabel -a <label_name> [-c <comments>]
Table 6-19 lists pmrep CreateLabel options and arguments:

Table 6-19. CreateLabel Options and Arguments Option -a -c Argument label_name comments Required/ Optional Required Optional Description Name of the label you are creating. Comments about the label.
CreateLabel
221
CreateUser
Adds a new user to the repository. A valid user name has no spaces and is case sensitive. If you create a user that has the same name as a user already registered with the repository, pmrep returns an error message. If you enter a group name that does not exist, pmrep returns an error and does not execute the command. If you do not enter a group name for the new user, pmrep assigns the new user to the Public group. To use the CreateUser command, you must have the Admin Repository privilege.
Note: You cannot use this command if the repository is using an external security module.
The CreateUser command uses the following syntax:

createuser -u <repository_user_name> {{-p <password> -c <confirm_password>} | -P <password_environment_variable>} [-d <description>] [-g <group_name>] [-i <contact_info> ]
Table 6-20 lists pmrep CreateUser options and arguments:

Table 6-20. CreateUser Options and Arguments Option -u -p Argument repository_user_name password Required/ Optional Required Conditional Description User name of the new user. The user name must be 7-bit ASCII, is case sensitive, and cannot contain spaces. Password of the new user. The password is case sensitive and cannot contain spaces. Use the -p or -P option, but not both. When you use the -p option, you must use the -c option. Ensures you enter the correct password. The confirm_password argument must match the password argument. You must use this option when you use the -p option. Password environment variable of the new user. The password is case sensitive and cannot contain spaces. Use the -p or -P option, but not both. When you use the -P option, do not use the -c option. Description of the new user. Group assigned to the new user. The new user inherits all permissions and privileges granted to the group. Contact information about the user.
-c
confirm_password
Conditional
-P
password_environment _variable
Conditional
-d -g -i
description group_name contact_info
222
Delete
Deletes the repository tables from the repository database. For more information about deleting a repository, see Managing the Repository in the Administrator Guide. Before you use the Delete command, you must connect to the repository and provide a user name and password or password environment variable. For more information about using the Connect command, see Connect on page 209. When you use the Delete command, the Repository Service must be running in exclusive mode. You can configure the Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd UpdateRepositoryService command. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about infacmd, see UpdateRepositoryService on page 107. To use the Delete command, you must have the Admin Repository privilege. The Delete command uses the following syntax:
delete [-x <repository_password_for_confirmation> | -X <repository_password_environment_variable_for_confirmation>] [-f (forceful delete: unregisters local repositories and deletes)]
Table 6-21 lists pmrep Delete options and arguments:

Table 6-21. Delete Options and Arguments Option -x Argument repository_password_for_ confirmation Required/ Optional Optional Description Repository password. You can use the -x or -X option, but not both. If you do not use the -x or -X option, pmrep prompts you to enter the repository password for confirmation. Repository password environment variable. You can use the -x or -X option, but not both. If you do not use the -x or -X option, pmrep prompts you to enter the repository password for confirmation. Deletes a global repository and unregisters local repositories. All registered local repositories must be running.
-X
repository_password_ environment_variable_for_ confirmation n/a
Optional
-f
Optional
Delete
223
DeleteConnection
Deletes a relational connection from the repository. To delete a connection, you must have the Manage Connection privilege with write permissions on the object or you must also own the object or be in the owners group. The DeleteConnection command uses the following syntax:
deleteconnection -n <relational_connection_name> [-f (force delete)]
Table 6-22 lists pmrep DeleteConnection options and arguments:

Table 6-22. DeleteConnection Options and Arguments Option -n -f Argument relational_connection_name n/a Required/ Optional Required Optional Description Name of the relational connection to delete. Connection will be deleted without further confirmation.
224
DeleteDeploymentGroup
Deletes a deployment group. If you delete a static deployment group, you also remove all objects from the deployment group. For more information about deleting deployment groups, see Working with Versioned Objects in the Repository Guide. To use the DeleteDeploymentGroup command, you must have the Manage Deployment Group privilege. The command returns deleteconnection completed successfully or returns Failed to execute deleteconnection message. The delete might fail for the following reasons:

The database connection does not exist. You do not have the Manage Connection privileges. The Repository Service cannot obtain a lock on the connection object.
The DeleteDeploymentGroup command uses the following syntax:

deletedeploymentgroup -p <deployment_group_name> [-f (force delete)]
Table 6-23 lists pmrep DeleteDeploymentGroup options and arguments:

Table 6-23. DeleteDeploymentGroup Options and Arguments Option -p -f Argument deployment_group_name n/a Required/ Optional Required Optional Description Name of the deployment group to delete. Deletes the deployment group without confirmation. If you omit this argument, pmrep prompts you for a confirmation before it deletes the deployment group.
DeleteDeploymentGroup
225
DeleteFolder
Deletes an existing folder from the repository. To use the DeleteFolder command, you must have the Manage Folder privilege. The DeleteFolder command uses the following syntax:
deletefolder -n <folder_name>
Table 6-24 lists pmrep DeleteFolder option and argument:

Table 6-24. DeleteFolder Option and Argument Option -n Argument folder_name Required/ Optional Required Description Name of the folder.
226
DeleteLabel
Deletes a label and removes the label from all objects that use it. If the label is locked, the delete fails. For more information about deleting labels, see Working with Versioned Objects in the Repository Guide. To use the DeleteLabel command, you must have the Manage Label privilege. The command returns DeleteFolder successfully completed or returns DeleteFolder failed. The deletion might fail for the following reasons:

You do not have Manage Folder privilege. The folder does not exist. The folder is being used by another user.
The DeleteLabel command uses the following syntax:

deletelabel -a <label_name> [-f (force delete)]
Table 6-25 lists pmrep DeleteLabel options and arguments:

Table 6-25. DeleteLabel Options and Arguments Option -a -f Argument label_name n/a Required/ Optional Required Optional Description Name of the label to delete. Delete the label without confirmation. If you omit this argument, the command prompts you for a confirmation before it deletes the label.
DeleteLabel
227
DeployDeploymentGroup
Deploys a deployment group. You can use this command to copy a deployment group within a repository or to a different repository. To use this command, you must create a control file with all the specifications that the Copy Wizard requires. The control file is an XML file defined by the depcntl.dtd file. For more information about the control file, see Using the Deployment Control File on page 316. If pmrep cannot immediately acquire object locks in the target repository, by default it waits indefinitely to acquire the locks. You can use the deployment control file parameters to specify a deployment timeout. The deployment timeout is the period of time (in seconds) that pmrep waits to acquire locks. A value of 0 fails the deployment if pmrep cannot immediately acquire locks. The default value is -1, which instructs pmrep to wait indefinitely to acquire the locks. For more information about specifying a deployment timeout, see Deployment Control File Parameters on page 318. Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire object locks. For more information about deploying a deployment group, see Copying Folders and Deployment Groups in the Repository Guide. To use the DeployDeploymentGroup command, you must have the Deploy privilege and the following permissions:

Read permission on the folder Read and execute permission on the deployment group
The DeployDeploymentGroup command uses the following syntax:

deploydeploymentgroup -p <deployment_group_name> -c <control_file_name> -r <target_repository_name> [-n <target_repository_user_name> [-x <target_repository_password> | -X <target_repository_password_environment_variable>] [-d <target_domain_name> | {-h <target_portal_host_name> -o <target_portal_port_number>}]] (only if target is in a different domain) [-l <log_file_name>]
228
Table 6-26 lists pmrep DeployDeploymentGroup options and arguments:

Table 6-26. DeployDeploymentGroup Options and Arguments Option -p -c Argument deployment_group_name control_file_name Required/ Optional Required Required Description Name of the group to deploy. Name of the XML file containing the Copy Wizard specifications. The control file is required. For more information about using the control file, see Using the Deployment Control File on page 316. Name of the target repository where you are copying the deployment group. Login user name for the target repository. Required if you copy the deployment group to a different repository. Login password for the target repository. You use the -x or -X option, but not both. If you copy the deployment group to a different repository and you do not use the -x or -X option, pmrep prompts you for the password. Login password environment variable for the target repository. You use the -x or -X option, but not both. If you copy the deployment group to a different repository and you do not use the -x or -X option, pmrep prompts you for the password. Name of the domain for repository. Required if you copy the deployment group to a different repository and you do not use the -h and -o options. Machine name for the node that hosts the domain of the target repository. Required if you copy the deployment group to a different repository and you do not use the -d option. Port number for the node that hosts the domain of the target repository. Required if you copy the deployment group to a different repository and you do not use the d option. Log file that records each deployment step. If you omit this option, pmrep outputs the deployment steps to the command line window.
-r -n
target_repository_name target_repository_user_ name target_repository_password
-x
Optional
-X
target_repository_password_ environment_variable
Optional
-d
target_domain_name
Conditional
-h
target_portal_host_name
Conditional
-o
target_portal_port_number
Conditional
-l
log_file_name
Optional
DeployDeploymentGroup
229
DeployFolder
Deploys a folder. You can use this command to copy a folder within a repository or to a different repository. To use this command, you must create a control file with all the specifications that the Copy Wizard requires. The control file is an XML file defined by the depcntl.dtd file. For more information about the control file, see Using the Deployment Control File on page 316. If pmrep cannot immediately acquire object locks in the target repository, by default it waits indefinitely to acquire the locks. You can use the deployment control file parameters to specify a deployment timeout. The deployment timeout is the period of time (in seconds) that pmrep waits to acquire locks. A value of 0 fails the deployment if pmrep cannot immediately acquire locks. The default value is -1, which instructs pmrep to wait indefinitely to acquire the locks. For more information about specifying a deployment timeout and check-in comments, see Deployment Control File Parameters on page 318. Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire object locks. To use the DeployFolder command, you must have the Deploy privilege and read permission on the folder. The DeployFolder command uses the following syntax:
deployfolder -f <folder_name> -c <control_file_name> -r <target_repository_name> [-n <target_repository_user_name> [-x <target_repository_password> | -X <target_repository_password_environment_variable>] [-d <target_domain_name> | {-h <target_portal_host_name> -o <target_portal_port_number>}]] (only if target is in a different domain) [-l <log_file_name>]
Table 6-27 lists pmrep DeployFolder options and arguments:

Table 6-27. DeployFolder Options and Arguments Option -f -c Argument folder_name control_file_name Required/ Optional Required Required Description Name of the folder to deploy. Name of the XML file containing the Copy Wizard specifications. For more information about the control file, see Using the Deployment Control File on page 316.
230
Table 6-27. DeployFolder Options and Arguments Option -r -n -x Argument target_repository_name target_repository_user_name target_repository_user_ password Required/ Optional Required Conditional Optional Description Name of the target repository you are copying the folder to. Login user name for the target repository. Required if you copy the folder to another repository. Login password for the target repository. Use the -x or -X option, but not both. If you copy the folder to a different repository and you do not use the -x or -X option, pmrep prompt you for the password. Login password environment variable for the target repository. Use the -x or -X option, but not both. If you copy the folder to a different repository and you do not use the -x or -X option, pmrep prompt you for the password. Name of the domain for the repository. Required if you copy the folder to a different repository and you do not use the -h and -o options. Machine name for the node that hosts the domain of the target repository. Required if you copy the folder to a different repository and you do not use the -d option. Port number for the node that hosts the domain of the target repository. Required if you copy the folder to a different repository and you do not use the -d option. Log file that records each deployment step. If you omit this option, pmrep outputs the deployment steps to the command line window.
-X
target_repository_password_ environment_variable
Optional
-d
target_domain_name
Conditional
-h
target_portal_host_name
Conditional
-o
target_portal_port_number
Conditional
-l
log_file_name
Optional
DeployFolder
231
EditUser
Edits the user name, password, and description of the user currently connected to the repository. You can also disable or enable users. This command requires you to connect to the repository. To use the EditUser command, you must have Admin Repository privilege. The EditUser command uses the following syntax:
edituser -u <repository_user_name> {{-p <new_password> -c <confirm_password>} | -P <new_password_environment_variable>} [ -l <new_login>] [ -d <new_description> ] [ -e <enablement_of_user> (yes or no) ] [ -i <contact_info> ]
Table 6-28 lists pmrep EditUser options and arguments:

Table 6-28. EditUser Options and Arguments Option -u -p Argument repository_user_name new_password Required/ Optional Required Conditional Description Replace the user name of the user currently connected to the repository. Replace the password of the user currently connected to the repository. Use this option if you use native authentication security. Otherwise the command fails. When you use this option, you must use the -c option. Required if you do not use the -P option. You must use the -p or -P option, but not both. This option ensures you enter the correct password. The confirm_password argument must match the new_password argument. If you use the -p option, you must also use the -c option. New password environment variable to replace the password of the user currently connected to the repository. Use this option if you use native authentication security. Otherwise the command fails. When you use this option, do not use the -c option. Required if you do not use the -p option. You must use the -p or -P option, but not both. Specifies a new login to map the user name. Use this option with an external directory service. New description of the user currently connected to the repository.
-c
confirm_password
Conditional
-P
new_password_ environment_variable
Conditional
-l -d
new_login new_description
Optional Optional
232
Table 6-28. EditUser Options and Arguments Option -e Argument enablement_of_user Required/ Optional Optional Description Enables or disables a user. Yes enables a user. No disables a user. To enable a user and enter a login name, use the -l option with this option. Contact information about the user.
-i
contact_info
Optional
Enabling and Disabling a User

If you use LDAP to authenticate users in the repository, use the following pmrep command to enable a user called JSmith:
edituser -u JSmith -l JohnS -e yes
The command associates his repository user name, JSmith, with the external login name of JohnS and enables him to use the repository.
EditUser
233
ExecuteQuery
Runs a query. You can choose to display the result or write the result to a persistent input file. If the query is successful, it returns the total number of qualifying records. Use this file as input to the ApplyLabel, AddToDeploymentGroup, and Validate commands. For more information about using a persistent input file, see Using the Persistent Input File on page 301. To use the ExecuteQuery command, you must have the Browse Repository privilege and Execute permission on the query. The ExecuteQuery command uses the following syntax:
executequery -q <query_name> [-t <query_type (shared or personal)>] [-u <output_persistent_file_name>] [-a (append)] [-c <column_separator] [-r <end-of-record_separator>] [-l <end-of-listing_indicator>] [-b (verbose)]
You must have execute permissions to run a query. Table 6-29 lists pmrep ExecuteQuery options and arguments:
Table 6-29. ExecuteQuery Options and Arguments Option -q -t Argument query_name query_type Required/ Optional Required Optional Description Name of the query to run. Type of query to run. You can specify public or private. If not specified, pmrep searches all the private queries first to find the matching query name. Then it searches the public queries. Send the query result to a text file. If you do not enter a file name, the query result goes to stdout. Appends the query results to the persistent output file. If you do not enter this option, pmrep overwrites the file content. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator. If you omit this option, pmrep uses a single space.
-u -a
persistent_output_file_name n/a
Optional Optional
-c
column_separator
Optional
234
Table 6-29. ExecuteQuery Options and Arguments Option -r Argument end-of-record_separator Required/ Optional Optional Description Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a new line. Character or set of characters used to specify the end of the object list. Enter a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a period. Verbose. Displays more than the minimum information about the objects. If you omit this option, pmrep prints a shorter format including the object type, the word reusable or non-reusable, the object name and path. Verbose format includes the object status, version number, folder name, and checked out information. The short format for global objects, such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the label type, query type, deployment group type, creator name, and creation time.
-l
end-of-listing_indicator
Optional
-b
n/a
Optional
ExecuteQuery
235
Exit
Exits from the pmrep interactive mode. The command line mode invokes and exits pmrep each time you issue a command. The Exit command uses the following syntax:
exit
236
FindCheckout
Displays a list of checked out objects in the repository. The listing contains the checked-out items unless you enter all users. If you choose an object type, then you can list checked-out objects in a specific folder or across all folders. If you do not specify an object type, pmrep returns all the checked-out objects in the repository. For more information about finding checked-out objects, see Working with Versioned Objects in the Repository Guide. To use the FindCheckout command, you must have the Browse Repository privilege and read permissions the folder. The FindCheckout command uses the following syntax:
findcheckout [-o <object_type>] [-f <folder_name>] [-u (all_users)] [-c <column_separator] [-r <end-of-record_separator>] [-l <end-of-listing_indicator>] [-b (verbose)]
Table 6-30 lists pmrep FindCheckout options and arguments:

Table 6-30. FindCheckout Options and Arguments Option -o Argument object_type Required/ Optional Conditional Description Object type you want to list. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, or dimension. If you do not use this option, pmrep ignores the -f and -u options and the command returns all checked-out objects in the repository. Return a list of checked out objects for the object type in the specified folder. The default is to list objects for the object type across folders. The folder name is optional if you specify an object type. List the checked out objects by all users. The default is to list checked out objects by the current user. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator. If you omit this option, pmrep uses a single space.
-f
folder_name
Conditional
-u -c
n/a column_separator
Optional Optional
FindCheckout
237
Table 6-30. FindCheckout Options and Arguments Option -r Argument end-of-record_separator Required/ Optional Optional Description Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names. Default is newline /n. Character or set of characters used to specify the end of the object list. Use a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a period. Verbose. Displays more than the minimum information about the objects. If you omit this option, pmrep prints a shorter format including the object type, the word reusable or non-reusable, the object name and path. Verbose format includes the version number and folder name. The short format for global objects such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the creator name and creation time.
-l
Optional
-b
n/a
Optional
238
Help
Returns the syntax for the command you specify. If you do not specify a command, then syntax for all of the pmrep commands is displayed. The Help command uses the following syntax:
help [command]
-or-help [command]
Help
239
KillUserConnection
Terminates user connections to the repository. You can terminate user connections based on the repository user name or connection ID. You can also terminate all user connections to the repository. To use the KillUserConnection command, you must have the Admin Repository privilege. The KillUserConnection command uses the following syntax:
killuserconnection {-i <connection_id> | -n <user_name> | -a (kill all)}
Table 6-31 lists pmrep KillUserConnection options and arguments:

Table 6-31. KillUserConnection Options and Arguments Option -i -n -a Argument connection_id user_name n/a Required/ Optional Conditional Conditional Conditional Description Repository connection ID. Repository user name. Terminates all connections.
240
ListAllGroups
Lists all groups registered with the repository by name. To use the ListAllGroups command, you must have the Admin Repository privilege. The ListAllGroups command uses the following syntax:
listallgroups
ListAllGroups
241
ListAllPrivileges
Lists all valid repository privileges for users or groups. Use the list of privileges to provide the privilege argument when adding or removing a privilege with pmrep. The ListAllPrivileges command uses the following syntax:
listallprivileges
242
ListAllUsers
Lists all user names registered with the repository. To use the ListAllUsers command, you must have the Admin Repository privilege. The ListAllUsers command uses the following syntax:
listallusers
ListAllUsers
243
ListGroupsForUser
Lists all groups that a user belongs to. To use the ListGroupsForUser command, you must have the Admin Repository privilege. The ListGroupsForUser command uses the following syntax:
listgroupsforuser -n <user_name>
Table 6-33 lists pmrep ListGroupsForUser option and argument:

Table 6-32. ListObjectDependencies Option and Argument Option -n Argument user_name Required/ Optional Required Description Name of the user to list groups for.
244
ListObjectDependencies
Lists dependency objects for reusable and non-reusable objects. If you want to list dependencies for non-reusable objects, you must use a persistent input file containing object IDs. You can create this file by running a query and choosing to create a text file. ListObjectDependencies accepts a persistent input file and it can create a persistent output file. These files are the same format. If you create an output file, use it as input to the ApplyLabel, AddToDeployment Group, or Validate pmrep commands. For more information about using a persistent input file, see Using the Persistent Input File on page 301. ListObjectDependencies returns the number of records if the command runs successfully. To use the ListObjectDependencies command, you must have the Browse Repository privilege and read permission on the folder. The ListObjectDependencies command uses the following syntax:
listobjectdependencies {{-n <object_name> -o <object_type> [-t <object_subtype>] [-v <version_number] [-f <folder_name>] } | -i <persistent_input_file>} [-d <dependency_object_types>] [-p <dependency_direction (children, parents, or both)>] [-s (include pk-fk dependency)] [-g (across repositories)] [-u <persistent_output_file_name> [-a (append)]] [-c <column_separator] [-r <end-of-record_separator>] [-l <end-of-listing_indicator>] [-b (verbose)]
Table 6-33 lists pmrep ListObjectDependencies options and arguments:

Table 6-33. ListObjectDependencies Options and Arguments Option -n -o Argument object_name object_type Required/ Optional Optional Required Description Name of a specific object to list dependencies for. Object type to list dependencies for. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session, session config, task, cube, and dimension. Type of transformation or task. Ignored for other object types. For valid subtypes, see Table 6-36 on page 251. List dependent objects for an object version other than the latest version.
-t -v
object_subtype version_number
245
Table 6-33. ListObjectDependencies Options and Arguments Option -f -i Argument folder_name persistent_input_file Required/ Optional Conditional Optional Description Folder containing object name. Folder is required if you do not use the -i option. Text file of objects generated from ExecuteQuery or Validate commands. You must use this file if you want to list dependencies for non-reusable objects. For more information about using the persistent input file, see Overview on page 300. If you use this option, then you cannot use the -n, -o, -f options to specify objects. Type of dependent objects to list. You can enter ALL or one or more object types. Default is ALL. If ALL, then pmrep lists all supported dependent objects. If you choose one or more objects, then pmrep lists dependent objects for these types. To enter multiple object types, separate them by commas without spaces. Parents or children dependent objects to list. You can specify parents, children, or both. Required if you do not use the -s option. If you do not use the -p option, pmrep does not list parent or child dependencies. Include the primary key-foreign key dependency object regardless of the direction of the dependency. Required if you do not use the -p option. If you do not use the -s option, pmrep does not list primary-key/foreign-key dependencies. Find object dependencies across repositories. Send the dependency result to a text file. Use the text file as input to the ApplyLabel, AddToDeployment Group, or Validate pmrep commands. The default sends the query result to stdout. Append the result to the persistent output file name file instead of overwriting it. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator. If you omit this option, pmrep uses a single space. Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names. Default is newline /n.
-d
dependency_object_t ypes
Optional
-p
dependency_direction
Conditional
-s
n/a
Conditional
-g -u
n/a persistent_output_file _name
Optional Optional
-a -c
n/a column_separator
Optional Optional
-r
end-ofrecord_separator
Optional
246
Table 6-33. ListObjectDependencies Options and Arguments Option -l Argument end-oflisting_indicator Required/ Optional Optional Description Character or set of characters used to specify the end of the object list. Enter a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a period. Verbose. Displays more than the minimum information about the objects. If you omit this option, pmrep displays a shorter format including the object type, the word reusable or nonreusable, the object name and path. Verbose format includes the version number and folder name. The short format for global objects, such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the creator name and creation time.
-b
n/a
Optional
247
ListObjects
Returns a list of objects in the repository. When you list objects, pmrep returns object metadata. Use the following list operations:

List object types. Define the objects you want to list. For more information about listing object types, see Listing Object Types on page 250. List folders. List all the folders in the repository. For more information about listing folders, including proper syntax, see Listing Folders on page 252. List objects. List reusable and non-reusable objects in the repository or in a folder. Fore more information about listing objects, see Listing Objects on page 252.
Use ListObjects in a shell script to return the object metadata, parse the metadata, and then use the parsed data in another pmrep command. For example, use ListObjects to list all Sequence Generator transformations in the repository. Create a shell script that uses ListObjects to return Sequence Generator transformation information, parse the data ListObjects returns, and use UpdateSeqGenVals to update the sequence values. pmrep returns each object in a record and returns the metadata of each object in a column. It separates records by a new line by default. You can enter the characters to use to separate records and columns. You can also enter the characters to indicate the end of the listing.
Tip: When you enter characters to separate records and columns and to indicate the end of the
listing, use characters that are not used in repository object names. This helps you use a shell script to parse the object metadata. To use the ListObjects command, you must have the Browse Repository privilege and read permission on the folder. The ListObjects command uses the following syntax:
listobjects -o <object_type> [-t <object_subtype>] [-f <folder_name>] [-c <column_separator>] [-r <end-of-record_indicator>] [-l <end-of-listing_indicator>] [-b (verbose)]
Do not use the -f option if the object type you list is not associated with a folder. The deployment group, folder, label, and query object types are not associated with folders. All other object types require the -f option.
248
Table 6-34 lists pmrep ListObjects options and arguments:

Table 6-34. ListObjects Options and Arguments Option -o Argument object_type Required/ Optional Required Description Type of object to list. - When you enter folder, you do not need to include any other option. pmrep ignores the -t and -f options. - When you enter objects other than folders, you must include the -f option. - When you enter transformation or task, you must include the -f option, and you can optionally include the -t option. For a list of object types to use with ListObjects, see Table 635 on page 250. Type of transformation or task to list. When you enter transformation or task for the object type, you can include this option to return a specific type. For a list of subtypes to use with ListObjects, see Table 6-36 on page 251. Folder to search. Use this option for all object types except deploymentgroup, folder, label, and query. Required if you list objects other than folders. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator. If you omit this option, pmrep uses a single space. Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names. Default is newline /n. Character or set of characters used to specify the end of the object list. Enter a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a period. Verbose. Display more than the minimum information about the objects. If you omit this option, you display a shorter format including the object type, the word reusable or nonreusable, the object name and path. Verbose format includes the object status, version number, folder name, and checked out information. The short format for global objects, such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the label type, query type, deployment group type, creator name, and creation time.
-t
object_subtype
Optional
-f
folder_name
Conditional
-c
column_separator
Optional
-r
end-of-record_indicator
Optional
-l
end_of_listing_indicator
Optional
-b
n/a
Optional
ListObjects
249
Listing Object Types

Use the object_type option to define the objects you want to list. The command lists the latest versions or checked out versions of objects, including shortcuts, but excluding objects according to the rules in Table 6-35. Table 6-35 lists the object types and rules you use with ListObjects:.
Table 6-35. Object Types and Rules Object Type Deploymentgroup Folder Label Mapplet Mapping Query Scheduler Session Sessionconfig Source Target Task Transformation Rule List deployment groups in the repository. List folders in the repository. List labels in the repository. List mapplets with latest or checked out version in a folder, including shortcuts but excluding instances of reusable mapplets. List mappings with latest or checked out version in a folder, including shortcuts but excluding instances of reusable mapplets. List queries in the repository. List reusable and non-reusable schedulers with latest or checked out version in a folder. List reusable and non-reusable sessions with latest or checked out version in a folder, excluding instances of reusable sessions. List the session configurations with latest or checked out version in a folder. List sources with latest or checked out version in a folder, including shortcuts but excluding source instances. List targets with latest or checked out version in a folder, including shortcuts but excluding target instances. List reusable and non-reusable tasks with latest or checked out version in a folder. List reusable and non-reusable transformations with latest or checked out version in a folder, including shortcuts and excluding instances of reusable transformations. List the workflows with latest version or checked out version in a folder. List reusable and non-reusable worklets with latest version or checked out version in a folder, excluding instances of reusable worklets.
Workflow Worklet
250
Table 6-36 lists the object types and values to use with pmrep commands:
Table 6-36. Transformation and Task Types to Use with pmrep Object Type Task Task Task Task Task Task Task Task Task Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Transformation Subtype Assignment Command Control Decision Email Event-raise Event-wait Start Timer Custom Aggregator Application Source Qualifier Application Multi-Group Source Qualifier Expression External Procedure Filter Input Java Joiner Lookup Mapplet MQ Source Qualifier Normalizer Output Rank Router Sequence Generator Sorter Source Qualifier Stored Procedure Subtype Value assignment command control decision email event_raise event_wait start timer custom_transformation aggregator application_source_qualifier app_multi-group_source_qualifier expression external_procedure filter input_transformation java joiner lookup_procedure mapplet mq_source_qualifier normalizer output_transformation rank router sequence sorter source_qualifier stored_procedure
ListObjects
251
Table 6-36. Transformation and Task Types to Use with pmrep Object Type Transformation Transformation Transformation Transformation Transformation Transformation Subtype Transaction Control Union Update Strategy XML Generator XML Parser XML Source Qualifier Subtype Value transaction_control custom_transformation update_strategy custom_transformation custom_transformation xml_source_qualifier
Listing Folders
Use ListObjects to return each folder in the repository. When you enter folder for the object type, pmrep ignores the subtype and folder name. For example, to list all folders in the repository, use the following syntax:
listobjects -o folder
Alternatively, you can enter a different column separator and end of listing indicator:
ListObjects -o folder -c ** -l #
Listing Objects
Use ListObjects to list reusable and non-reusable objects in the repository or in a folder. pmrep does not include instances of reusable objects. When you list objects, you must include the folder name for all objects that are associated with a folder. pmrep returns the name of the object with the path when applicable. For example, when a transformation is in a mapping or mapplet, pmrep returns mapping_name.transformation_name or mapplet_name.transformation_name. For a list of transformation or task return values, see Table 6-36 on page 251. For example, to list all transformation types in a folder, enter the following text at the prompt:
listobjects -o transformation -f myfolder
pmrep returns the following information:

stored_procedure reusable sp_sproc1 expression reusable exp1 stored_procedure non-reusable mapping1.sp_nsproc sequence non-reusable smallmapplet.seqgen_empid .listobjects completed successfully.
To list all Stored Procedure transformations in a folder, enter the following text at the prompt:
listobjects -o transformation -t stored_procedure -f myfolder
252

stored_procedure reusable sp_sproc1 stored_procedure non-reusable mapping1.sp_nsproc .listobjects completed successfully.
To list all sessions in a folder, enter the following text at the prompt:
listobjects -o session -f myfolder

session reusable s_sales_by_CUSTID session non-reusable wf_sales.s_sales_Q3 session non-reusable wf_orders.wl_shirt_orders.s_shirt_orders .listobjects completed successfully.
ListObjects
253
ListTablesBySess
Returns a list of sources or targets used in a session. When you list sources or targets, pmrep returns source or target instance names to the window. Use ListTablesBySess in a shell script with other pmrep commands. For example, you can create a shell script that uses ListTablesBySess to return source instance names and uses Updatesrcprefix to update the source owner name. When you use ListTablesBySess, pmrep returns source and target instance names as they appear in the session properties. For example, if the mapping contains a mapplet with a source, pmrep returns the source instance name in the following format:
mapplet_name.source_name
To use the ListTablesBySess command, you must have the Use Workflow Manager privilege and read permission on the folder. The ListTablesBySess command uses the following syntax:
listtablesbysess -f <folder_name> -s [<qualifying_path>.]<session_name> -t <object_type_listed> (source or target)
Table 6-37 lists pmrep ListTablesBySess options and arguments:

Table 6-37. ListTablesBySess Options and Arguments Option -f -s Argument folder_name session_name Required/ Optional Required Required Description Name of the folder containing the session. Name of the session containing the sources or targets. You can enter a reusable or non-reusable session name. However, you cannot enter an instance of a reusable session name. To enter a non-reusable session name in a workflow, enter the workflow name and the session name as workflow_name.session_name. Enter source to list sources, or enter target to list targets.
-t
object_type_liste d
Required
For example, to list all sources in a reusable session, enter the following text at the prompt:
listtablesbysess -f myfolder -s s_reus_sess1 -t source

ITEMS mapplet1.ORDERS Shortcut_To_ITEM_ID listtablesbysess completed successfully.
254
When the mapping contains a mapplet with a source, pmrep includes the mapplet name with the source, such as mapplet1.ORDERS. For example, you can list all targets in a non-reusable session in a workflow:
listtablesbysess -f myfolder -s wf_workkflow1.s_nrsess1 -t target

target1_inst ORDERS_BY_CUSTID Shortcut_To_tgt2_inst listtablesbysess completed successfully.
ListTablesBySess
255
ListUserConnections
Lists information for each user connected to the repository. To use the ListUserConnections command, you must have the Admin Repository privilege. The ListUserConnections command uses the following syntax:
listuserconnections
256
LsPrivileges
Lists the privileges assigned to a user or group. To use the LsPrivileges command, you must have the Admin Repository privilege. The LsPrivileges command uses the following syntax:
lsprivileges {-u <user_name> | -g <group_name>} [-o (ignore group)]
Table 6-38 lists pmrep LsPrivileges options and arguments:

Table 6-38. LsPrivileges Options and Arguments Option -u -g -o Argument user_name group_name n/a Required/ Optional Conditional Conditional Optional Description Name of the user to list privileges for. Required if you do not use the -g option. Use -u or -g, but not both. Name of the group to list privileges for. Required if you do not use the -u option. Use -u or -g, but not both. Ignores privileges that the user inherits from groups. Lists only the privileges that are assigned directly to the user. Use the -o option with the -u option only. The -o option has no effect when you use the -g option.
LsPrivileges
257
ModifyFolder
Modifies folder properties. You modify a folder in a non-versioned repository. To use the ModifyFolder command, you must be the folder owner or have the Manage Folder privilege. The ModifyFolder command uses the following syntax:
modifyfolder -n <folder_name> [-d <folder_description>] [-o <owner_name>] [-g <group_name>] [-s (shared folder)] [-p <permissions>] [-r <new_folder_name>] [-f <folder_status> (active, frozendeploy, or frozennodeploy)]
Table 6-39 lists the pmrep ModifyFolder options and arguments:

Table 6-39. ModifyFolder Options and Arguments Option -n -d -o -g Argument folder_name folder_description owner_name group_name Required/ Optional Required Optional Optional Optional Description New folder name. Description of the folder that displays in the Repository Manager. Current owner of the folder. Any user in the repository can be the folder owner. Default owner is the current user. Repository user group to receive Owners Group permissions. Groups to which the owner belongs can be selected. Makes the folder shared. Access rights for the folder. If omitted, the Repository Service uses existing permissions. For more information about assigning permissions, see Assigning Permissions on page 218. New name of the folder. Change the folder status to one of the following status: - active. This status allows users to check out versioned objects in the folder. - frozendeploy (Frozen, Allow Deploy to Replace). This status prevents users from checking out objects in the folder. Deployment into the folder creates new versions of the objects. - frozennodeploy (Frozen, Do Not Allow Deploy to Replace). This status prevents users from checking out objects in the folder. You cannot deploy objects into this folder.
-s -p
shared_folder permissions
Optional Optional
-r -f
new_folder_name folder_status
Optional Optional
258
Notify
Sends notification messages to users connected to a repository or users connected to all repositories managed by a Repository Service. To use the Notify command, you must have the Admin Repository privilege. The command returns ModifyFolder successfully completed or returns ModifyFolder Failed message. The modification might fail for the following reasons:

You do not have the Manage Folder privilege. The folder does not exist. The new owner does not exist or does not belong to the group. A folder with the new folder name already exists.
The Notify command uses the following syntax:

notify -m <message>
Table 6-40 lists pmrep Notify option and argument:

Table 6-40. Notify Option and Argument Option -m Argument message Required/ Optional Required Description Message you want to send.
The command returns notify successfully completed or returns failed to execute notify message. The notification might fail for the following reasons:

The message you entered is invalid. You failed to connect to the Repository Service. The Repository Service failed to notify users.
Notify
259
ObjectExport
Exports objects to an XML file defined by powrmart.dtd. You export an object by name. If you enter an object, you must enter the name of the folder that contains it. If you do not enter a version number, you export the latest version of the object. Use a persistent input file to specify different objects to export at one time. You can create this file by using the ExecuteQuery, Validate, or ListObjectDependencies pmrep commands. If you use the persistent input file, do not use the other parameters to specify objects. For more information about using the persistent input file, see Using the Persistent Input File on page 301. For more information about exporting objects, see Exporting and Importing Objects in the Repository Guide. If you export a mapping, by default PowerCenter exports the mapping and its instances. If you want to include dependent objects, you must add the appropriate pmrep options. You can optionally include reusable and non-reusable dependent objects, objects referenced by shortcuts, and related objects in a primary key-foreign key relationship. To export mapping dependencies, you must use the -b and -r options. To use the ObjectExport command, you must have the Browse Repository privilege and read permission on the folder. The ObjectExport command uses the following syntax:
objectexport {{-n <object_name> -o <object_type> [-t <object_subtype>] [-v <version_number] [-f <folder_name>]} | -i <persistent_input_file>} [-m (export pk-fk dependency)] [-s (export objects referred by shortcut)] [-b (export non-reusable dependents)] [-r (export reusable dependents)] -u <xml_output_file_name> [-l <log_file_name>]
Table 6-41 lists pmrep ObjectExport options and arguments:

Table 6-41. ObjectExport Options and Arguments Option -n Argument object_name Required/ Optional Conditional Description Name of a specific object to export. If you do not enter this option, pmrep exports all the latest or checked out objects in the folder. Required if you do not use the -i option. Use the -n option or the -i option, but not both. Object type of the object name. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, or task. If you use this option, you cannot use the -i option.
-o
object_type
Conditional
260
Table 6-41. ObjectExport Options and Arguments Option -t Argument object_subtype Required/ Optional Optional Description Type of transformation or task. This argument is ignored for other object types. For valid subtypes, see Table 6-36 on page 251. Exports the version of the object that you enter. Name of the folder containing the object to export. If you do not enter an object name, pmrep exports all the objects in this folder. If you use this option, you cannot use the -i option. Text file list of objects generated from ExecuteQuery, Validate, or ListObjectDependencies. It contains object records with encoded IDs. Required if you do not use the -n option. If you use this parameter, you cannot use the -n, -o, or -f options. Exports primary key table definitions when you export sources or targets with foreign keys. Exports the original object referenced by the shortcut. Exports non-reusable objects used by the object. Must specify -b and -r to export mapping dependencies. Exports reusable objects used by the object. Must specify -b and -r to export mapping dependencies. Name of the XML file to contain the object information. Log file that records each export step. If you omit this option, status messages output to the window.
-v -f
version_number folder_name
Optional Conditional
-i
persistent_input_file
Conditional
-m -s -b -r -u -l
n/a n/a n/a n/a xml_output_file_ name log_file_name
Optional Optional Optional Optional Required Optional
ObjectExport
261
ObjectImport
Imports objects from an XML file. This command requires a control file to specify the objects to import and how to resolve conflicts. The control file is an XML file defined by the impcntl.dtd file. For more information about the control file, see Using the Object Import Control File on page 303. To use the ObjectImport command, you must have the Use Repository Manager privilege and read or write permission on the folder. For more information about importing objects, see Exporting and Importing Objects in the Repository Guide. The ObjectImport command uses the following syntax:
objectimport -i <input_xml_file_name> -c <control_file_name> [-l <log_file_name>] [-p (retain persistent value)]
Table 6-42 lists pmrep ObjectImport options and arguments:

Table 6-42. ObjectImport Options and Arguments Option -i -c Argument input_XML_file_name control_file_name Required/ Optional Required Required Description Name of the XML file to import. Name of the control file that defines import options. For more information, see Using the Object Import Control File on page 303. Log file that records each export step. If you omit this option, status messages output to the window. Retains persistent values for mapping variables.
-l -p
log_file_name n/a
Optional Optional
Note: The ObjectImport command does not create a folder if the folder name you enter does
not exist in the repository.
262
Register
Registers a local repository with a connected global repository. You must connect to the global repository before you register the local repository. Also, you must run the Repository Service for the local repository in exclusive mode. You can configure the Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd UpdateRepositoryService command. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about infacmd, see UpdateRepositoryService on page 107. To use the Register command, you must have the Admin Repository privilege. The command returns register successfully completed or returns failed to execute register message. The registration might fail for the following reasons:

You do not have Admin Repository privilege. You failed to connect to the Repository Service. The local repository is not running in exclusive mode. The Repository Service failed to initialize information about the global repository. The Repository Service failed to register the local repository with the global repository.
The Register command uses the following syntax:

register -r <local_repository_name> -n <local_repository_user_name> [-x <local_repository_password> | -X <local_repository_password_environment_variable>] [-d <local_repository_domain_name> | {-h <local_repository_portal_host_name> -o <local_repository_portal_port_number>}] (only if local repository is in a different domain)
Table 6-43 lists pmrep Register options and arguments:

Table 6-43. Register Options and Arguments Option -r -n -x Argument local_repository_name local_repository_user_name local_repository_password Required/ Optional Required Required Optional Description Name of the local repository to register. Local repository user name. Login password for the local target repository. You use the -x or -X option, but not both. If you do not use the -x or -X option, pmrep prompts you for the password. Login password environment variable for the local target repository. You use the -x or -X option, but not both. If you do not use the -x or -X option, pmrep prompts you for the password.
-X
repository_password_ environment_variable
Optional
Register
263
Table 6-43. Register Options and Arguments Option -d Argument local_repository_domain_name Required/ Optional Conditional Description Name of the PowerCenter domain for the repository. Required if the local repository is in a different domain and you do not use the -h and -o options. Machine name of the domain where the local repository is located. If you use this option, you must also use the -o option. Required if the local repository is in a different domain and you do not use -d. Port number for the domain where the local repository is located. If you use this option, you must also use the -h option. Required if the local repository is in a different domain and you do not use -d.
-h
local_repository_portal_host_n ame
Conditional
-o
local_repository_portal_port_nu mber
Conditional
264
RegisterPlugin
Registers an external plug-in to a repository. Registering a plug-in adds its functionality to the repository. Use the RegisterPlugin command to update existing plug-ins. For more information about registering a plug-in, see Managing the Repository in the Administrator Guide. When you use this command, the Repository Service must be running in exclusive mode. You can configure the Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd UpdateRepositoryService command. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about infacmd, see UpdateRepositoryService on page 107. To use the RegisterPlugin command, you must have the Admin Repository privilege. The RegisterPlugin command uses the following syntax:
registerplugin -i <input_registration_file_name_or_path> [-e (update plug-in)] [-l <NIS_login> {-w <NIS_password> | -W <NIS_password_environment_variable>} [-k (CRC check on security library)]]
Table 6-44 lists pmrep RegisterPlugin options and arguments:

Table 6-44. RegisterPlugin Options and Arguments Option -i -e -l Argument input_registration_file_name_ or_path n/a NIS login Required/ Optional Required Optional Optional Description Name or path of the registration file for the plug-in. Update an existing plug-in. Not applicable for authentication modules. Registers security module components. Provide the NIS login of the user registering an external security module. If the plug-in contains an authentication module, you must supply the external login name, or the registration fails. This login becomes the administrator user name in the repository. Do not use this option for other plug-ins. Use to register authentication module components. External directory password of the user registering the module. If the plug-in contains an authentication module, you must supply the user password from the external directory or the registration fails. Do not use this option for other plug-ins. Use the -w or -W option, but not both. If you do not supply a password or password environment variable, pmrep prompts you for a password.
-w
NIS password
Optional
RegisterPlugin
265
Table 6-44. RegisterPlugin Options and Arguments Option -W Argument NIS_password_environment_ variable Required/ Optional Optional Description Use to register authentication module components. External directory password environment variable of the user registering the module. If the plug-in contains an authentication module you must supply the user password from the external directory or the registration fails. Do not use this option for other plug-ins. Use the -w or -W option, but not both. If you do not supply a password or password environment variable, pmrep prompts you for a password. Stores the CRC of the plug-in library in the repository. When the Repository Service loads the module, it checks the library against the CRC.
-k
n/a
Optional
Registering a Security Module

If you want to use an external directory service to maintain users and passwords for a repository, you must register the security module with the repository. Use the Registerplugin command to register the security plug-in.
Example
You administer PowerCenter for an organization that has a centralized LDAP NIS for user authentication. When you upgrade PowerCenter, you decide to use the LDAP for repository user authentication. The upgrade installs the LDAP security module in the repository security folder. The administrator runs the pmrep command to register the new external module with the repository:
pmrep registerplugin -r repositoryname -n Administrator -x RepoPasswd -t oracle -u admin-ora -p admin-passwd-ora -c oracle-server001 -i security/ ldap_authen.xml -l adminuser -w admnpass
The -l login name and -w login password options contain the valid NIS login information for the user running the pmrep command. After registration, you must use this login name and password to access the repository.
Note: The login name and password must be valid in the external directory, or the
administrator cannot access the repository using LDAP. The -i option contains the XML file name that describes the security module. For more information about security modules, see Managing the Repository in the Administrator Guide.
266
RegisterUser
Registers a login from an external directory service and associate it with a repository user name. Use this command if you use LDAP to authenticate repository users. To use the RegisterUser command, you must have the Admin Repository privilege. The RegisterUser command uses the following syntax:
registeruser -u <repository_user_name> -l <external_login> [-d <description>] [-g <group_name>] [-i <contact_info>]
Table 6-45 lists the pmrep RegisterUser options and arguments:

Table 6-45. RegisterUser Options and Arguments Option -u -l -d -g -i Argument repository_user_name external_login description group_name contact_info Required Optional Required Required Optional Optional Optional Description Name to add as a repository user. Login name in the external directory. Description of the user. Assigns the user to a group. If you omit this option, the user is assigned to Public. Contact information about the user.
RegisterUser
267
Restore
Restores a repository backup file to a database. The target database must be empty. When you restore a repository to a Repository Service, the Repository Service can retain the same user authentication module. If the repository uses repository authentication, then all existing repository user accounts remain valid. Use the following guidelines to continue using the external directory service when you restore the repository:

Restore the repository with the same LDAP server. Ensure the LDAP server is running when you restore the repository. Provide the repository administrator user account or another user account defined in the external directory service. Use the -v option to provide the administrator or other user name. Use the x option to provide the password for the account. You must provide a valid user name and password for a user in the external directory service.
If you do not following the guidelines, the Repository Service unregisters the external security module after it restores the repository. If the Repository Service unregisters the external security module, the default repository authentication is enabled. The user accounts defined in the external directory service cannot log in to the repository. All user accounts defined in the repository are now valid. The repository administrator must use the default administrator user name and password to log in to the repository. If the authentication method changes to repository authentication and you want to use an external security module, register the security module with the repository. For more information about registering an LDAP security module with a repository, see Managing the Repository in the Administrator Guide. When you restore a repository to a different system, you might want to deploy objects between the restored repository and the original repository. Use the -n option to create a copy of the repository that has no deployment history. If you restore the repository without this option, you create a duplicate repository that includes the deployment history. To use the Restore command, you must have permission on the Repository Service in the domain. For more information about restoring a repository, see Managing the Repository in the Administrator Guide. The pmrep Restore command uses the following syntax:
restore -u <domain_user_name> [-p <domain_password> | -P <domain_password_environment_variable>] -i <input_file_name> [-g (create global repository)] [-y (enable object versioning)] [-v <confirm_repository_user_name> (For external security module only.) {-x <confirm_repository_password> (For external security module only.)|
268
-X <confirm_repository_password_environment_variable> (For external security module only.)} [-w (remove user-name-login mapping if unregistering external security module)]] [-b (skip workflow and session logs)] [-j (skip deployment group history)] [-q (skip MX data)] [-f (skip task statistics)] [-a (as new repository)]
Table 6-46 lists pmrep Restore options and arguments:

Table 6-46. Restore Options and Arguments Option -u -p Argument domain_user_name domain_password Required/ Optional Required Optional Description Domain user name. Repository database password. You can use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the domain password. Repository database password environment variable. You can use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the domain password. Name of the repository backup file. Use a file name and path local to the Repository Service. Promotes the repository to a global repository. Enables object versioning for the repository. User name of the repository administrator or another valid user defined in the external directory service. Required to retain the existing external security module. The Repository Service verifies the user name against the external directory service. If the user name is invalid or not provided, the Repository Service unregisters the external security module from the restored repository and registers the restored repository with the default repository authentication. Password for the user name supplied with the -v option, as defined in the external directory service. Required to retain the existing external security module. Use this option with the -v option. The Repository Service verifies the password against the external directory service. If the password is invalid or not provided, the Repository Service unregisters the external security module from the restored repository, and registers the restored repository with the default repository authentication. You must use either the -x or -X option, but not both, when you want to retain an external security module.
-P
domain_password_environment _variable
Optional
-i -g -y -v
input_file_name n/a n/a confirm_repository_user_name
Required Optional Optional Optional
-x
confirm_repository_password
Optional
Restore
269
Table 6-46. Restore Options and Arguments Option -X Argument confirm_repository_password_ environment_variable Required/ Optional Optional Description Password environment variable that stores the password of the repository administrator as defined in the external directory service. Required to retain the existing external security module. Use this option with the -v option. Repository Service verifies the password against the external directory service. If the password is invalid or not provided, the Repository Service unregisters the external security module from the restored repository, and registers the restored repository with the default repository authentication. You must use either the -x or -X option, but not both, when you want to retain an external security module. Removes user-name-login mapping. Use this option when unregistering an external module. Skips tables related to workflow and session logs during restore. Skips deployment group history during restore. Skips tables related to MX data during restore. Skips task statistics during restore. Creates new internal folder IDs for folders in the restored repository. This enables you to copy folders and deployment groups between the original repository and the restored repository. If you do not use -a, you cannot copy folders and deployment groups between the original and restored repositories.
-w -b -j -q -f -a
n/a n/a n/a n/a n/a n/a
Optional Optional Optional Optional Optional Optional
Example
The following example restores a repository as a versioned repository and specifies the administrator user name and password to retain the LDAP security module registration.
restore -u administrator -p password -i repository1_backup.rep -y -v repo_user -x repo_password
270
RmGroup
Removes a group from the repository and reassigns all users in that group to the Public group. You must connect to the repository to use this command. When you remove a group, users in the group lose the privileges inherited from the group. If any user in the group is connected to the repository when you remove the group, the privilege changes take effect the next time the user connects to the repository.
Note: You cannot remove the Public or Administrators group.
To use the RmGroup command, you must have the Admin Repository privilege. The RmGroup command uses the following syntax:
rmgroup -g <group_name>
Table 6-47 lists the pmrep RmGroup option and argument:

Table 6-47. RmGroup Option and Argument Option -g Argument group_name Required/ Optional Required Description Name of the group you want to remove.
RmGroup
271
RmPrivilege
Removes a privilege from a user or group. You cannot remove a privilege from a user and a group at the same time. If the user or users in the group are connected to the repository when you remove the privilege, the change takes effect the next time the user connects to the repository. To use the RmPrivilege command, you must have the Admin Repository privilege. The RmPrivilege command uses the following syntax:
rmprivilege -p <privilege> {-u <repository_user_name> | -g <group_name>}
Table 6-48 lists pmrep RmPrivilege options and arguments:

Table 6-48. RmPrivilege Options and Arguments Option -p Argument privilege Required/ Optional Required Description Privilege you want to remove. If the privilege contains spaces, you must enclose this argument in quotes, such as Admin Repository. Name of the user from whom you want to remove the privilege. If you use this option, you cannot use the -g option. Name of the group from which you want to remove the privilege. If you use this option, you cannot use the -u option.
-u
repository_user_name
Conditional
-g
group_name
Conditional
272
RmUser
Removes a user from the repository or from the user-name-login mapping, depending on the type of user authentication you use. You cannot remove the Administrator user name from the repository. If you remove a user while the user is connected to the repository, the removal takes effect after the user disconnects from the repository. To use the RmUser command, you must have the Admin Repository privilege. The RmUser command uses the following syntax:
rmuser -u <repository_user_name>
Table 6-49 lists the pmrep RmUser option and argument:

Table 6-49. RmUser Option and Argument Option -u Argument repository_user_name Required/ Optional Required Description User name you want to remove from the repository.
RmUser
273
RmUserFromGroup
Removes an existing user from a group. You must be connected to the repository to use this command. The user loses permissions and privileges associated with the group. If the user is connected to the repository when you remove the user from a group, the change takes effect the next time the user connects to the repository. To use the RmUserFromGroup command, you must have the Admin Repository privilege. The RmUserFromGroup command uses the following syntax:
rmuserfromgroup -u <repository_user_name> -g <group_name>
Table 6-50 lists pmrep RmUserFromGroup options and arguments:

Table 6-50. RmUserFromGroup Options and Arguments Option -u -g Argument repository_user_name group_name Required/ Optional Required Required Description User name to remove from the group. Name of the group from which to remove the user.
274
Run
Takes a script file containing multiple pmrep commands and runs those commands sequentially. If the script file is UTF-8 encoded, you must use the -u option and the repository code page must be UTF-8. If you run a UTF-8 encoded script file that includes the Connect command against a repository that does not have a UTF-8 code page, the Run command will fail. If the script file is not UTF-8 encoded, omit the -u option. If you use the -o option and the -u option, pmrep generates the output file in UTF-8. If you use the -o option and omit the -u option, pmrep generates the output file based on the system locale of the machine where you run pmrep. The command returns run successfully completed or returns run failed message. The run might fail if the Repository Service cannot open the script file or output file. The Run command uses the following syntax:
run -f <script_file_name> [-o <output_file_name>] [-e (echo commands)] [-s (stop at first error)] [-u (UTF-8 encoded script file and output file)]
Table 6-51 lists pmrep Run options and arguments:

Table 6-51. Run Options and Arguments Option -f -o Argument script file name output file name Required/ Optional Required Optional Description Name of the script file. Name of the output file. This option writes all messages generated by the commands in the script file into the output file. If you use the -u option and the -o option, pmrep generates a UTF-8 encoded output file. If you use the -o option without the -u option, pmrep encodes the output file based on the system locale of the machine running pmrep. Commands are echoed back to the script. Stops running the script after the first error. Encodes the output file in UTF-8 format. If you use the -u option and the -o option, pmrep also encodes the output file in UTF-8 format. Use this option only if the repository code page is UTF-8.
-e -s -u
n/a n/a n/a
Run
275
ShowConnectionInfo
Returns the repository name and user information for the current connection. Use the ShowConnectionInfo command in interactive mode. When you connect to a repository in interactive mode, the pmrep keeps the connection information in memory until you exit the repository or connect to a different repository. When you use the ShowConnectionInfo command in command line mode, a message indicating failure to execute the command is given. pmrep does not keep connection information in command line mode. The ShowConnectionInfo command does not connect to the repository. For more information about connections in command line mode and interactive mode, see Help on page 239. The ShowConnectionInfo command uses the following syntax:
showconnectioninfo
It returns information similar to the following:

Connected to Repository MyRepository in MyDomain as user MyUserName
276
SwitchConnection
Changes the name of an existing connection. When you use SwitchConnection, the Repository Service replaces the relational database connections for all sessions using the connection in one of the following locations:

Source connection Target connection Connection Information property in Lookup transformations Connection Information property in Stored Procedure transformations $Source Connection Value session property $Target Connection Value session property
If the repository contains both relational and application connections with the same name and you specified the connection type as relational in all locations in the repository, the Repository Service replaces the relational connection. For example, you have a relational and an application source, each called ITEMS. In a session, you specified the name ITEMS for a relational source connection instead of Relational:ITEMS. When you use SwitchConnection to replace the relational connection ITEMS with another relational connection, pmrep does not replace any relational connection in the repository because it cannot determine the connection type for the source connection entered as ITEMS. To use the SwitchConnection command, you must have the SuperUser privilege and read permissions on both connection objects. The SwitchConnection command uses the following syntax:
switchconnection -o <old_connection_name> -n <new_connection_name>
To replace connections with pmrep, you must have Admin Repository privilege. Table 6-52 lists pmrep SwitchConnection options and arguments:
Table 6-52. SwitchConnection Options and Arguments Option -o -n Argument old_connection_name new_connection_name Required/ Optional Required Required Description Name of the existing connection you want to change. New connection name.
SwitchConnection
277
TruncateLog
Deletes details from the repository. You can delete all logs, or delete logs for a folder or workflow. You can also enter a date and delete all logs older than that date. To use the TruncateLog command, you must have the Admin Repository privilege. The command returns truncatelog completed successfully or returns Failed to execute truncatelog message. The truncate operation might fail for the following reasons:

You do not have Admin Repository privilege. The folder name is invalid. The workflow does not exist in the given folder. You specified a workflow, but no folder name.
The TruncateLog command uses the following syntax:

truncatelog -t <logs_truncated (all or MM/DD/YYYY HH24:MI:SS format for the endtime)> [-f <folder_name>] [-w <workflow_name>]
Table 6-53 lists pmrep TruncateLog options and arguments:

Table 6-53. TruncateLog Options and Arguments Option -t Argument logs_truncated Required/ Optional Required Description Use all to delete all the logs, or enter an endtime with the format MM/DD/YYYY HH24:MI:SS. pmrep deletes all logs older than the endtime. Deletes logs associated with the folder. If you do not give both the folder name and the workflow name, then pmrep deletes all logs from the repository. Deletes logs associated with the workflow. The Repository Service deletes all logs from the repository if you do not give both the folder name and the workflow name. If you give both the folder name and workflow name, the Repository Service deletes logs associated with the workflow. If you enter the workflow name, you must also provide the folder name.
-f
folder_name
Optional
-w
workflow_name
Optional
278
UndoCheckout
Reverses the checkout of an object. When you undo a checkout, the repository releases the write-intent lock on the object and reverts to the most recently checked in version of the object. If you want to modify the object again, you must check it out. For more information about undoing a checkout, see Working with Versioned Objects in the Repository Guide. Users with Admin Repository privilege can undo checkouts for other users. To use the UndoCheckout command, you must have the follow sets of permissions and privileges:

Use Repository Manager (for object owner) with write permission on the folder Admin Repository
The UndoCheckout command uses the following syntax:

undocheckout -o <object_type> [-t <object_subtype>] -n <object_name> -f <folder_name>
Table 6-54 lists pmrep UndoCheckout options and arguments:

Table 6-54. UndoCheckout Options and Arguments Option -o Argument object_type Required/ Optional Required Description Type of object. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, and dimension. Type of transformation or task. Ignored for other object types. For valid subtypes, see Table 6-36 on page 251. Name of the checked out object. Name of the folder containing the object.
-t -n -f
object_subtype object_name folder_name
Optional Required Required
UndoCheckout
279
Unregister
Unregisters a local repository from a connected global repository. To use this command, you must run the Repository Service for the local repository in exclusive mode. You can configure the Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd UpdateRepositoryService command. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about infacmd, see UpdateRepositoryService on page 107. To use the Unregister commands, you must have the Admin Repository privilege. The command returns unregister successfully completed or returns failed to execute unregister message. The registration might fail for the following reasons:

The Repository Service for the local repository is not running in exclusive mode. You do not have Admin Repository privilege. The Repository Service failed to initialize information about the global repository. You failed to connect to the Repository Service.
The Unregister command uses the following syntax:

unregister -r <local_repository_name> -n <local_repository_user_name> [-x <local_repository_password> | -X <repository_password_environment_variable>] [-d <local_repository_domain_name> | {-h <local_repository_portal_host_name> -o <local_repository_portal_port_number>}] (only if local repository is in a different domain)
Table 6-55 lists pmrep Unregister options and arguments:

Table 6-55. Unregister Options and Arguments Option -r -n -x Argument local_repository_name local_repository_user_name local_repository_password Required/ Optional Required Required Required Description Name of the local repository to unregister. Local repository user name. Login password for the local target repository. Required if you do not use the -X option. You must use the -x or -X option, but not both. Login password environment variable for the local target repository. Required if you do not use the -x option. You must use the -x or -X option, but not both.
-X
local_repository_password_ environment_variable
Conditional
280
Table 6-55. Unregister Options and Arguments Option -d Argument local_repository_domain _name local_repository_portal_host _name Required/ Optional Conditional Description Name of the PowerCenter domain for repository. Required if the local repository is in a different domain and you do not use the -h and -o options. Machine name of the domain where the local repository is located. Required if the local repository is in a different domain and you do not use the -d option. If you use this option, you must use the -o option as well. Port number for the domain where the local repository is located. Required if the local repository is in a different domain and you do not use the -d option. If you use this option, you must use the -h option as well.
-h
Conditional
-o
local_repository_portal_port _number
Conditional
Unregister
281
UnregisterPlugin
Removes a plug-in from a repository. You can add and remove plug-ins to extend system functionality. A plug-in is a software module that introduces new repository metadata. For more information about unregistering plug-ins, see Managing the Repository in the Administrator Guide. When you use this command, the Repository Service must be running in exclusive mode. You can configure the Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd UpdateRepositoryService command. For more information about configuring the Repository Service, see Managing the Repository in the Administrator Guide. For more information about the UpdateRepositoryService infacmd command, see UpdateRepositoryService on page 107. To use the UnRegisterPlugin command, you must have the Admin Repository privilege. The UnregisterPlugin command uses the following syntax:
unregisterplugin -v <vendor_id> -l <plug-in_id> [-s (is security module) [-g (remove user-name-login mapping)] {-w <new_password> | -W <new_password_environment_variable>}]
Table 6-56 lists pmrep UnregisterPlugin options and arguments:

Table 6-56. UnregisterPlugin Options and Arguments Option -v Argument vendor_id Required/ Optional Required Description Identifies the security plug-in by vendor identification number. You define this number when you register the plug-in. Identifies the plug-in by identification number. You define this identification number when you register the plug-in. Indicates whether the module is an external security module. For more information about registering external security modules, see Managing the Repository in the Administrator Guide. Applicable when registering an external security module. Removes the association between user names and login names in the repository when you unregister an external security module. If you omit this option, you retain the association in the repository, but the Repository Manager does not display it anywhere. Use this option when you are unregistering a security module.
-l
plug-in_id
Required
-s
n/a
Optional
-g
n/a
Optional
282
Table 6-56. UnregisterPlugin Options and Arguments Option -w Argument new_password Required/ Optional Conditional Description Specifies a new password for the user running the UnregisterPlugin command. When you unregister an external authentication module, all user passwords reset to the values in the repository. You must enter a new password to access the repository. Required when the plug-in contains a security module. Required if you do not use the -W option. You must use the -w or -W option, but not both. Specifies a new password environment variable for the user running the unregister command. When you UnregisterPlugin an external authentication module, all user passwords reset to the values in the repository. You must enter a new password to access the repository. Required when the plug-in contains a security module. Required if you do not use the -w option. You must use the -w or -W option, but not both.
-W
new_password_ environment_variable
Conditional
Unregistering an External Security Module

Use the UnregisterPlugin command to discontinue using an external security module with a repository. If you unregister the external security module, PowerCenter switches to repository authentication mode. All user passwords reset to the values in the repository instead of the values in the external directory. When you unregister the security module, you do not lose the mapping between the repository user names and the external security login names unless you enter the -g option. Use the mapping again if you register a new security module.
Note: Although you can save the associations between external logins and repository user
names, the Repository Manager does not display the external logins while running under repository user authentication. You must use the -w or -W option to create a new password when you unregister the security module.
Example
As an administrator, you decide to switch from the LDAP security module back to repository authentication. You remove the user name-login mapping. Any users that you added to the system under repository authentication can log in with their old user names and passwords. Any users you added to the repository under the LDAP security cannot log in until you enable their user names.
Note: You must provide the LDAP NIS login and password to use the UnregisterPlugin
command. You must also provide a new password to use after you switch back to repository user authentication.
UnregisterPlugin
283
UpdateConnection
Updates the user name, password, connect string, and attributes for a database connection. The command returns an operation successfully completed or returns operation failed message. A failure might occur for the following reasons:

The database type is not supported. The connection object does not exist. The current user does not have the appropriate permissions. pmrep cannot acquire a lock on the object. One of the required parameters is missing.
To use the UpdateConnection command, you must be the owner of the object or have write permission on the connection object. The UpdateConnection command uses the following syntax:
updateconnection -t <database_type> -d <database_connection_name> -u <new_user_name> [-p <new_database_password> | -P <new_database_password_environment_variable>] -c <new_database_connection_string> [-a <attribute_name> -v <new_attribute_value>]
Table 6-57 lists pmrep UpdateConnection options and arguments:

Table 6-57. UpdateConnection Options and Arguments Option -t -d -u -p Argument database_type database_connection_ name new_user_name new_database_ password Required/ Optional Required Required Required Optional Description Type of relational connection. For a list of valid database types, see Table 6-14 on page 214. Database connection name. User name used for authentication when you connect to the relational database. Password used for authentication when you connect to the relational database. Use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the password. Password environment variable used for authentication when you connect to the relational database. Use the -p or -P option, but not both. If you do not use the -p or -P option, pmrep prompts you for the password.
-P
new_database_ password_environment_ variable
Optional
284
Table 6-57. UpdateConnection Options and Arguments Option -c Argument new_database_ connection_string attribute_name new_attribute_value Required/ Optional Required Description Connect string the Integration Service uses to connect to the relational database. For a list of native connect strings, see Table 6-11 on page 209. Name of the attribute. New attribute value of the connection. Required if you use the -a option. Enter yes to enable new attributes, and no to disable new attributes.
-a -v
Optional Conditional
UpdateConnection
285
UpdateEmailAddr
Updates the session notification email addresses associated with the Email tasks assigned to the session. If you did not previously enter a success or failure Email task for the session, the command does not update the email addresses. You can update the email notification addresses for a non-reusable session with a unique name in the folder. You can enter different addresses to receive either success or failure notifications. This command requires you to connect to a repository. To use the UpdateEmailAddr command, you must have the SuperUser privilege. The UpdateEmailAddr command uses the following syntax:
updateemailaddr -d <folder_name> -s <session_name> -u <success_email_address> -f <failure_email_address>
Table 6-58 lists pmrep UpdateEmailAddr options and arguments:

Table 6-58. UpdateEmailAddr Options and Arguments Option -d -s -u -f Argument folder_name session_name success_email_address failure_email_address Required/ Optional Required Required Required Required Description Name of the session folder. Name of the session. Email address to send session success notifications. Email address to send session failure notifications.
286
UpdateSeqGenVals
Updates one or more of the following properties for the specified Sequence Generator transformation:

Start Value End Value Increment By Current Value
You might want to update sequence values when you move a mapping from a development environment to a production environment. Use the UpdateSeqGenVals command to update reusable and non-reusable Sequence Generator transformations. However, you cannot update values for instances of reusable Sequence Generator transformations or shortcuts to Sequence Generator transformations. For more information about configuring Sequence Generator transformations, see Sequence Generator Transformation in the Transformation Guide. To use the UpdateSeqGenVals command, you must have the SuperUser privilege. The UpdateSeqGenVals command uses the following syntax:
updateseqgenvals -f <folder_name> [-m <mapping_name>] -t <sequence_generator_name> [-s <start_value>] [-e <end_value>] [-i <increment_by>] [-c <current_value>]
Table 6-59 lists pmrep UpdateSeqGenVals options and arguments:

Table 6-59. UpdateSeqGenVals Options and Arguments Option -f -m Argument folder_name mapping_name Required/ Optional Required Conditional Description Folder name. Mapping name. When you update values for a nonreusable Sequence Generator transformation, you must include the mapping name. Sequence Generator transformation name.
-t
sequence_generator_name
Required
UpdateSeqGenVals
287
Table 6-59. UpdateSeqGenVals Options and Arguments Option -s Argument start_value Required/ Optional Optional Description Start value of the generated sequence you want the Integration Service to use if the Sequence Generator transformation uses the Cycle property. If you select Cycle in the transformation properties, the Integration Service cycles back to this value when it reaches the end value. If you designate an invalid value, pmrep gives an error message and does not update the Sequence Generator transformation. Maximum value the Integration Service generates. If the Integration Service reaches this value during the session and the sequence is not configured to cycle, it fails the session. If you designate an invalid value, pmrep displays an error message and does not update the Sequence Generator transformation. Difference between two consecutive values from the NEXTVAL port. If you designate an invalid value, pmrep displays an error message and does not update the Sequence Generator transformation. Current value of the sequence. Enter the value you want the Integration Service to use as the first value in the sequence. If you want to cycle through a series of values, the current value must be greater than or equal to the start value and less than the end value. If you designate an invalid value, pmrep gives an error message and does not update the Sequence Generator transformation.
-e
end_value
Optional
-i
increment_by
Optional
-c
current_value
Optional
288
UpdateSrcPrefix
Updates the owner name for session source tables. You can update the owner name for one or all sources in a session. Updatesrcprefix updates the owner name for source tables at the session level. pmrep updates source table owner names if you previously edited the source table name in the session properties. To use the UpdateSrcPrefix command, you must have the SuperUser privilege. The UpdateSrcPrefix command uses the following syntax:
updatesrcprefix -f <folder_name> -s [<qualifying_path>.]<session_name> [-t <source_name>] -p <prefix_name> [-n (use source instance name; not using -n gives old, deprecated behavior)]
Table 6-60 lists the pmrep UpdateSrcPrefix options and arguments:

Table 6-60. UpdateSrcPrefix Options and Arguments Option -f -s Argument folder_name session_name Required/ Optional Required Required Description Name of the folder containing the session. Name of the session containing the sources to update. For reusable sessions, enter the session name. For non-reusable sessions, you must also enter the session path, such as worklet_name.session_name or workflow_name.session_name. Name of the source to update. If you omit this option, pmrep updates all source table owner names in the session. When you include the -n option, you enter the name of the source instance as displayed in the session properties or as output by the ListTablesBySess command. Although the UpdateSrcPrefix command will run without the -n option, include the -n option to use the source instance name. If you omit the -n option, you must enter the dbd name and the source table name as dbd_name.source_name. You can find the source dbd name in the Designer Navigator. The Designer generates the dbd name from the source type or data source name when you create a source definition in the repository.
-t
source_name
Optional
UpdateSrcPrefix
289
Table 6-60. UpdateSrcPrefix Options and Arguments Option -p -n Argument prefix_name n/a Required/ Optional Required Optional Description Owner name you want to update in the source table. Matches the source_name argument with source instance names. Although the UpdateSrcPrefix command will run without the -n option, include the -n option to use the source instance name. When you do not include this option, pmrep matches the source_name argument with the source table names.
290
UpdateStatistics
Updates statistics for repository tables and indexes. To use the UpdateStatistics command, you must have the Admin Repository privilege. The command returns updatestatistics completed successfully or returns updatestatistics failed message. The update fails if you do not have Admin Repository privilege. For more information about updating statistics, see Managing the Repository in the Administrator Guide. The UpdateStatistics command uses the following syntax:
updatestatistics
UpdateStatistics
291
UpdateTargPrefix
Updates the table name prefix for session target tables. The table name prefix specifies the owner of the table in the database. You can update the owner name for one or all targets specified in a session. UpdateTargPrefix updates the target table name prefix at the session level. To use the UpdateTargPrefix command, you must have the SuperUser privilege. pmrep updates table name prefixes if you previously edited the table name prefix at the session level. The UpdateTargPrefix command uses the following syntax:
updatetargprefix -f <folder_name> -s [<qualifying_path>.]<session_name> [-t <target_name>] -p <prefix_name> [-n (use target instance name; not using -n gives old, deprecated behavior)]
Table 6-61 lists the pmrep UpdateTargPrefix options and arguments:

Table 6-61. UpdateTargPrefix Options and Arguments Option -f -s Argument folder_name session_name Required/ Optional Required Required Description Name of the folder containing the session. Name of the session containing the targets to update. For reusable sessions, enter the session name. For non-reusable sessions, enter the session name and session path, such as worklet_name.session_name or workflow_name.session_name. Name of the target to update. If you omit this option, pmrep updates all target table name prefixes in the session. When you include the -n option, you can enter the name of the target instance as displayed in the session properties or as output by the ListTablesBySess command. Although the UpdateTargPrefix command will run without the -n option, include the -n option to use the target instance name. When you omit the -n option, you must enter the target table name instead of the target instance name. Table name prefix you want to update in the target table. Matches the target name argument with target instance names. Although the UpdateTargPrefix command will run without the -n option, include the -n option to use the target instance name. When you omit this option, pmrep matches the target name argument with the target table names.
-t
target_name
Optional
-p -n
prefix_name n/a
Required Optional
292
Upgrade
Upgrades a repository to the latest version. For more information about upgrading repositories, see Upgrading PowerCenter in the Installation and Configuration Guide. To use the Upgrade command, you must have the Admin Repository privilege. The Upgrade command uses the following syntax:
upgrade [-x <repository_password_for_confirmation> | -X <repository_password_environment_variable_for_confirmation>]
Table 6-62 lists pmrep Upgrade options and arguments:

Table 6-62. Upgrade Options and Arguments Option -x Argument repository_ password_ for_confirmation Required/ Optional Optional Description Repository password. You can use the -x or -X option, but not both. If you do not use the -x or -X option, pmrep prompts you to enter the repository password for confirmation. Repository password environment variable. Required if you do not use the -x option. You must use the -x or -X option, but not both.
-X
repository_password_ environment_variable_ for_confirmation
Conditional
Upgrade
293
Validate
Validates objects. You can output the results to a persistent output file or standard output. It also displays a validation summary to stdout. The summary includes the number of valid objects, invalid objects, and skipped objects. The persistent output file contains standard information, encoded IDs, and a CRC check. You can save and check in the objects that change from invalid to valid. You can validate the following types of objects:

Mappings Mapplets Sessions Workflows Worklet objects
If you use another type of object in the input parameter, pmrep returns an error. If you use the wrong type of object in a persistent input file, pmrep reports an error and skips the object.
Note: The pmrep Validate command does not validate shortcuts.
When you run Validate, you can output information about object status:

valid. Objects successfully validated. saved. Objects saved after validation. skipped. Shortcuts and object types that do not require validation. save_failed. Objects that did not save because of lock conflicts or they were checked out by another user. invalid_before. Objects invalid before the validation check. invalid_after. Objects invalid after the validation check.
To use the Validate command, you must have the Use Repository Manager privilege and read permission on the folder. The Validate command uses the following syntax:
validate {{-n <object_name> -o <object_type (mapplet, mapping, session, worklet, workflow)> [-v <version_number>] [-f <folder_name>]} | -i <persistent_input_file>} [-s (save upon valid) [-k (check in upon valid) [-m <check_in_comments>]]] [-p <output_option_types (valid, saved, skipped, save_failed, invalid_before, invalid_after, or all)> [-u <persistent_output_file_name>] [-a (append)] [-c <column_separator>]
294
[-r <end-of-record_separator>] [-l <end-of-listing_indicator>] [-b (verbose)]
Table 6-63 lists pmrep Validate options and arguments:

Table 6-63. Validate Options and Arguments Option -n -o Argument object_name object_type Required/ Optional Required Conditional Description Name of the object to validate. Do not use this option if you use the -i argument. Type of object to validate. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, dimension. Required if you are not using a persistent input file. Version of the object to validate. Default is the latest or checked out version of the object. Name of the folder containing the object. Text file from ExecuteQuery, Validate, or ListObjectDependencies commands. Contains a list of object records. You cannot use this file if you specify objects using the -n, -o, or -f arguments. Save objects that change from invalid to valid to the repository. Check in saved objects. Required if you use -s. Add comments when you check in an object. Required if you use the -k option, and the current repository requires checkin comments. Type of object you want to output to the persistent output file or stdout after validation. You can specify valid, saved, skipped, save_failed, invalid_before, or invalid_after. To enter one or more options, separate them by commas. Required if you use the -u argument. Name of an output text file. If you enter a file name, the query writes the results to a file. Use this option if you use the - p argument. Append the results to the persistent output file instead of overwriting it. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator. If you omit this option, pmrep uses a single space.
-v -f -i
version_number folder_name persistent_input_file
Optional Required Optional
-s -k -m
n/a n/a check_in_comments
Optional Optional Conditional
-p
output_option_types
Conditional
-u
persistent_output_file_name
Conditional
-a -c
append column_separator
Optional Optional
Validate
295
Table 6-63. Validate Options and Arguments Option -r Argument end-of-record_separator Required/ Optional Optional Description Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names. Default is newline /n. Character or set of characters used to specify the end of the object list. Enter a character or set of characters that is not used in repository object names. If you omit this option, pmrep uses a period. Verbose. Displays more than the minimum information about the objects. If you omit this option, pmrep displays a shorter format including the object type, the word reusable or non-reusable, the object name and path. Verbose format includes the version number and folder name. The short format for global objects such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the creator name and creation time.
-l
Optional
-b
n/a
Optional
296
Version
Displays the PowerCenter version and Informatica trademark and copyright information. The Version command uses the following syntax:
version
Version
297
298
Chapter 7
Working with pmrep Files

Overview, 300 Using the Persistent Input File, 301 Using the Object Import Control File, 303 Object Import Control File Examples, 307 Using the Deployment Control File, 316 Deployment Control File Examples, 321 Tips, 324
299
Overview
pmrep includes a set of control files that you use to define how to import objects into the repository. The control file parameters use the same parameters in the control file that you use in the PowerCenter Client. You can use the following control files:
Persistent input file. Use a persistent input file to specify repository objects that you want to process. For more information about the persistent input file, see Using the Persistent Input File on page 301. Object import control file. Use the object import control file and specify a set of questions to help define how objects are imported. For more information about the object import control file, see Using the Object Import Control File on page 303. Deployment control file. You can copy the objects in a dynamic or static deployment group to multiple target folders in the target repository. The deployment operation creates new versions of existing objects in target folders. For more information about deployment control files, see Using the Deployment Control File on page 316.
300
Chapter 7: Working with pmrep Files
Using the Persistent Input File

When you run pmrep with some tasks, use a persistent input file to specify repository objects that you want to process. The persistent input file represents objects already in the repository. You can create a persistent input file manually or by using pmrep. Use a persistent input file with the following pmrep commands:

AddToDeploymentGroup. Add objects to a deployment group. ApplyLabel. Label objects. ExecuteQuery. Run a query to create a persistent input file. Use the file for other pmrep commands. ListObjectDependencies. List dependency objects. This command can use a persistent input file for processing, and it can create one. ObjectExport. Export objects to an XML file. Validate. Validate objects. This command can use a persistent input file for processing, and it can create one.
The persistent input file uses the following format:

encoded ID, foldername, object_name, object_type, object_subtype, version_number, resusable|non-reusable
Creating a Persistent Input File with pmrep

You can create a persistent input file using the pmrep ExecuteQuery, Validate, or ListObjectDependencies commands. These commands create files that contain a list of objects with encoded IDs and a cyclic redundancy check (CRC) value. It also contains an encrypted repository GID. This ID identifies which repository the record comes from and prevents you from misusing the file and corrupting a repository. For more information about the CRC value, see Exporting and Importing Objects in the Repository Guide. The pmrep commands that use a persistent input file get object information from the encoded IDs. The encoded IDs enable pmrep to process the input file quickly. When you create a persistent input file with pmrep, it creates the file in the pmrep installation directory. You can specify a different path. The following is a sample persistent input file:
2072670638:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944199885:138608640183285:1376256153425:131072168215:65536142655:0288235: 088154:65536122855,EXPORT,M_ITEMS,mapping,none,2 1995857227:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944135065:13867417666804:1376256233835:19660880104:65536271545:0319425:01 7154:6553644164,EXPORT,M_ITEMS_2,mapping,none,3 1828891977:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944279765:138739712184505:137625613474:65536221345:65536133675:091734:090 53:65536156675,EXPORT,M_NIELSEN,mapping,none,1 3267622055:57bfc2ff-df64-40fc-9cd4a15cb489bab8:353894462954:138805248300075:1376256151365:6553675414:65536174015:0273455:024 1435:65536261685,EXPORT,M_OS1,mapping,none,1
Using the Persistent Input File
301
Example
You can use the ExecuteQuery command to create a persistent input file of objects to process in another pmrep command. For example, you want to export all logically deleted objects from the repository. You might create a query called find_deleted_objects. When you run the query with pmrep, as shown here, it finds all the deleted objects in the repository and outputs the results to a persistent input file:
ExecuteQuery -q find_deleted_objects -t private -u deletes_workfile
You can then use deletes_workfile as the persistent input file to ObjectExport:
ObjectExport -i deletes_workfile -u exported_del_file
ObjectExport exports all the referenced objects to an XML file called exported_del_file.
Creating a Persistent Input File Manually

If you manually create a persistent input file, you must enter the word none in place of the encoded ID. The pmrep commands get the object information from the other arguments in the records. You must put the arguments in the correct order. pmrep requires you to enter all the column arguments, except for the last column. Use the reusable or non-reusable column for object types that can be reusable or non-reusable, such as transformations, sessions, worklets, and tasks. Object_subtype is the type of transformation or task. If the object is not a transformation or task, put the word none in the object_subtype argument. For information about valid transformations and task types, see Table 6-36 on page 251. This is an example from a manually created file:
none, myfolder,Oracle.newsrc,source,none,2
The object is a reusable source object. It includes the database definition as a prefix. The record has the word none in place of the encoded ID, and the record does not require the reusable argument. The value 2 indicates the version number.
302
Using the Object Import Control File

When you use the pmrep ObjectImport command, you can supply a control file to answer questions that you normally address when you import objects with the Import Wizard. To create a control file, you must create an XML file defined by impcntl.dtd. The import control file is installed with the PowerCenter Client, and you must include its location in the input XML file. The following is a sample of the impcntl.dtd file:
       <!ELEMENT IMPORTPARAMS (FOLDERMAP*, TYPEFILTER*, RESOLVECONFLICT?)> <!ATTLIST IMPORTPARAMS CHECKIN_AFTER_IMPORT CHECKIN_COMMENTS APPLY_LABEL_NAME RETAIN_GENERATED_VALUE COPY_SAP_PROGRAM APPLY_DEFAULT_CONNECTION > (YES | NO) "NO" CDATA CDATA #IMPLIED #IMPLIED
(YES | NO) "NO" (YES | NO) "YES" (YES | NO) "NO"
 <!ELEMENT FOLDERMAP EMPTY> <!ATTLIST FOLDERMAP SOURCEFOLDERNAME CDATA #REQUIRED #REQUIRED #REQUIRED #REQUIRED
SOURCEREPOSITORYNAME CDATA TARGETFOLDERNAME CDATA
TARGETREPOSITORYNAME CDATA >
  <!ELEMENT TYPEFILTER EMPTY> <!ATTLIST TYPEFILTER
303
TYPENAME >
CDATA
#REQUIRED
 <!ELEMENT RESOLVECONFLICT (LABELOBJECT | QUERYOBJECT | TYPEOBJECT | SPECIFICOBJECT)*>
 <!ELEMENT LABELOBJECT EMPTY> <!ATTLIST LABELOBJECT LABELNAME RESOLUTION > CDATA (REPLACE | REUSE | RENAME) #REQUIRED #REQUIRED
 <!ELEMENT QUERYOBJECT EMPTY> <!ATTLIST QUERYOBJECT QUERYNAME RESOLUTION > CDATA (REPLACE | REUSE | RENAME) #REQUIRED #REQUIRED
 <!ELEMENT TYPEOBJECT EMPTY> <!ATTLIST TYPEOBJECT OBJECTTYPENAME RESOLUTION > CDATA REPLACE | REUSE | RENAME) #REQUIRED #REQUIRED
       <!ELEMENT SPECIFICOBJECT EMPTY> <!ATTLIST SPECIFICOBJECT NAME DBDNAME CDATA CDATA #REQUIRED #IMPLIED #REQUIRED #REQUIRED #REQUIRED #REQUIRED>
OBJECTTYPENAME CDATA FOLDERNAME CDATA
REPOSITORYNAME CDATA RESOLUTION
(REPLACE | REUSE | RENAME)
304
Object Import Control File Parameters

Table 7-1 lists pmrep Object Import control file parameters:
Table 7-1. Object Import Control File Elements and Attributes Element IMPORTPARAMS Attribute Name CHECKIN_AFTER_IMPORT Required/ Optional Conditional Attribute Description Checks in objects when they successfully import. Required if versioning is enabled. Applies the comments to the checked in objects. Applies the label name on the imported objects. Retains existing Sequence Generator, Normalizer, and XML Source Qualifier transformation current values in the destination. Required if you use Sequence Generator, Normalizer, or XML Source Qualifier transformations. Copies SAP program information into the target repository. Applies the default connection when a connection used by a session does not exist in the target repository. The default connection is the first connection from the sorted list of available connections. Finds the list of connections in the Workflow Manager. Import folder name to match to a folder in the target repository. Repository containing the source folder. Target folder name for matching. Repository containing the target folder. Imports the objects from a specific node, such as sources, targets, or mappings. You can specify conflict resolutions for objects. Identifies objects by label name for conflict resolution specification. Replace, Reuse, Rename. Identifies objects from this query for conflict resolution specification.
CHECKIN_COMMENTS APPLY_LABEL_NAME RETAIN_GENERATED_VALUE
Optional Optional Conditional
COPY_SAP_PROGRAM APPLY_DEFAULT_CONNECTION
Optional Optional
FOLDERMAP
SOURCEFOLDERNAME SOURCEREPOSITORYNAME TARGETFOLDERNAME TARGETREPOSITORYNAME
Required Required Required Required Optional
TYPEFILTER
TYPENAME
RESOLVECONFLICT
See LABELOBJECT, QUERYOBJECT, TYPEOBJECT, AND SPECIFICOBJECT elements. LABELNAME RESOLUTION
n/a
LABELOBJECT
Required Required Required
QUERYOBJECT
QUERYNAME
305
Table 7-1. Object Import Control File Elements and Attributes Element Attribute Name RESOLUTION TYPEOBJECT OBJECTTYPENAME RESOLUTION SPECIFICOBJECT NAME DBDNAME OBJECTTYPENAME FOLDERNAME REPOSITORYNAME RESOLUTION Required/ Optional Required Required Required Required Optional Required Required Required Required Attribute Description Replace, Reuse, or Rename. Object type for this conflict resolution. For a list of object types, see Table 7-2. Replace, Reuse, or Rename. Specific object name for this conflict resolution. Source DBD to identify source object. Object type for this conflict resolution. For a list of object types, see Table 7-2. Source folder the containing object. Source repository containing the object. Replace, Reuse, or Rename.
Table 7-2 lists the object types to use with the OBJECTTYPENAME attribute:
Table 7-2. Object Types for OBJECTTYPENAME Attribute Aggregator Assignment Custom Event-raise External Procedure Joiner Mapplet Output Scheduler SessionConfig Source Qualifier Timer Update Strategy XML Generator Application Multi-Group Source Qualifier Command Decision Event-wait Filter Lookup Procedure MQ Source Qualifier Rank Session Sorter Start Transaction Control Workflow XML Parser Application Source Qualifier Control Email Expression Input Mapping Normalizer Router Sequence Generator Source Definition Target Definition Union Transformation Worklet XML Source Qualifier
306
Object Import Control File Examples

The parameters you specify in the control file code determine the actions that take place when you run the ObjectImport command in pmrep. The following examples discuss instances in which you use the ObjectImport command with a control file to import repository objects. The elements and attribute names that are key to performing the described tasks are designated with comments in the code. Table 7-3 provides a description of sample object import control files:
Table 7-3. Object Import Control File Examples Function Import source objects. Import multiple objects into a folder. Description Use the TYPEFILTER element to import only source objects. For more information, see Importing Source Objects on page 308. Use the IMPORTPARAMS and FOLDERMAP elements to import multiple objects. For more information, see Importing Multiple Objects into a Folder on page 309. Use the CHECKIN_AFTER_IMPORT and APPLY_LABEL_NAME attributes of the IMPORTPARAMS element to label imported objects. For more information, see Checking In and Labeling Imported Objects on page 309. Use the RETAIN_GENERATED_VALUE attribute of the IMPORTPARAMS element to retain Sequence Generator and Normalizer values when you import objects. For more information, see Retaining Sequence Generator and Normalizer Values on page 309. Use all attributes of the FOLDERMAP element to import objects and local shortcut objects that reference the objects. For more information, see Importing Objects and Local Shortcut Objects to the Same Repository on page 310. Use all attributes of the FOLDERMAP element to import shortcut objects from another repository. For more information, see Importing Shortcut Objects from Another Repository on page 310. Use all attributes of the FOLDERMAP element to import objects to multiple folders. For more information, see Importing Objects to Multiple Folders on page 311. Use the TYPEFILTER element to import specific objects. For more information, see Importing Specific Objects on page 311. Use the OBJECTTYPENAME and RESOLUTION attributes of the TYPEOBJECT element to reuse and replace dependent objects. For more information, see Reusing and Replacing Dependent Objects on page 312. Use the QUERYOBJECT element to replace invalid mappings. For more information, see Replacing Invalid Mappings on page 312.
Check in and label imported objects.
Retain Sequence Generator and Normalizer transformation values.
Import objects and local shortcut objects to the same repository.
Import shortcut objects from another repository. Import objects to multiple folders.
Import specific objects. Reuse and replace dependent objects.
Replace invalid mappings.
307
Table 7-3. Object Import Control File Examples Function Rename objects. Description Use the RESOLUTION attribute of the SPECIFICOBJECT element to rename objects. For more information, see Renaming Objects on page 313. Use the COPY_SAP_PROGRAM attribute of the IMPORTPARAMS element to copy SAP mappings and SAP program information. For more information, see Copying SAP Mappings and SAP Program Information on page 314. Use the APPLY_DEFAULT_CONNECTION attribute of the IMPORTPARAMS element to apply default connection attributes. For more information, see Applying Default Connection Attributes on page 314. Use the RESOLVECONFLICT element to resolve object conflicts. For more information, see Resolving Object Conflicts on page 314.
Copy SAP mappings and SAP program information.
Apply default connection attributes.
Resolve object conflicts.
Importing Source Objects

You can import source objects. For example, you want to replace all the duplicate objects labeled Monthend in the target folder. However, you want to rename conflicting source objects that contain Yr_End in the object name. You have a query called yr_end_qry that finds these objects. You might create a control file with the following attributes:
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT ="NO"> <FOLDERMAP SOURCEFOLDERNAME ="OLD_ACCOUNTING" SOURCEREPOSITORYNAME ="OLD_REPOS" TARGETFOLDERNAME ="NEW_ACCOUNTING" TARGETREPOSITORYNAME ="NEW_REPOS"/>
 <TYPEFILTER TYPENAME ="SOURCE"/> <RESOLVECONFLICT> <LABELOBJECT LABELNAME ="Monthend" RESOLUTION = "REPLACE"/> <QUERYOBJECT QUERYNAME ="yr_end_qry" RESOLUTION ="RENAME"/> </RESOLVECONFLICT> </IMPORTPARAMS>
308
Importing Multiple Objects into a Folder

You can import multiple objects into a folder, check them in, and label them. For example, you want to import the objects to folder SRC_F1 and apply the label LABEL_IMPORT_NEW to the objects. You might create a control file with the following attributes:
<xml version="1.0" encoding="UTF-8"?> <!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">  <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="NEWOBJECTS" APPLY_LABEL_NAME="LABEL_IMPORT_NEW"> <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="TGT_REPO1"/> </IMPORTPARAMS>
Checking In and Labeling Imported Objects

You can import objects into a folder, check them in, label them, and resolve the conflict between session configuration objects. For example, you want to export the objects from folder SRC_F1 and import them into folder TGT_F1. The Repository Service creates a session configuration in the target folder by default. You include the APPLY_LABEL_NAME attribute in the IMPORTPARAMS element to label the imported objects, and the RESOLVECONFLICT element in the control file to resolve the conflict. You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">  
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="VERSION1" APPLY_LABEL_NAME="LABEL_IMPORT_NEW"> <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="TGT_REPO1"/> <RESOLVECONFLICT> <TYPEOBJECT OBJECTTYPENAME="SessionConfig" RESOLUTION="REUSE"/> </RESOLVECONFLICT> </IMPORTPARAMS>
Retaining Sequence Generator and Normalizer Values

You can retain the values of Sequence Generator and Normalizer transformations when you import objects and replace all objects in the target folder. You might create a control file with the following attributes:
309
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">  <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="VERSION1" APPLY_LABEL_NAME="LABEL_IMPORT_NEW" RETAIN_GENERATED_VALUE="YES">w <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="TGT_REPO1"/> <RESOLVECONFLICT> <TYPEOBJECT OBJECTTYPENAME="ALL" RESOLUTION="REPLACE"/> </RESOLVECONFLICT> </IMPORTPARAMS>
Importing Objects and Local Shortcut Objects to the Same Repository

You can import objects and their respective local shortcut objects to the same repository. For example, you have folders named SRC_SHARED_F1 and SRC_NONSHARED_F1. The SRC_NONSHARED_F1 folder is not shared and contains local shortcut objects that reference objects in the SRC_SHARED_F1 folder. You want to import the objects to different folders in the target repository, and you want the shortcut objects in folder TGT_NONSHARED_F1 to point to the objects in TGT_SHARED_F1. You might create a control file with the following attributes:
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT="NO">
 <FOLDERMAP SOURCEFOLDERNAME="SRC_SHARED_F1" SOURCEREPOSITORYNAME="SRC__REPO1" TARGETFOLDERNAME="TGT_SHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/> <FOLDERMAP SOURCEFOLDERNAME="SRC_NONSHARED_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_NONSHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/> </IMPORTPARAMS>
Importing Shortcut Objects from Another Repository

You can import objects from other repositories. For example, you have folders in a local repository that contain shortcuts to objects in a global repository. You want to import the global shortcut objects to a repository that is registered to the global repository and maintain shortcuts to the original objects in the global repository. You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="global objects" APPLY_LABEL_NAME="LABEL_IMPORT_GLOBAL_SHORTCUT">
310

<FOLDERMAP SOURCEFOLDERNAME="SRC_SHARED_F1" SOURCEREPOSITORYNAME="SRC_GDR_REPO1" TARGETFOLDERNAME="SRC_SHARED_F1" TARGETREPOSITORYNAME="SRC_GDR_REPO2"/> <FOLDERMAP SOURCEFOLDERNAME="SRC_NONSHARED_F1" SOURCEREPOSITORYNAME="SRC_LDR_REPO1" TARGETFOLDERNAME="TGT_NONSHARED_F1" TARGETREPOSITORYNAME="SRC_LDR_REPO2"/> </IMPORTPARAMS>
Importing Objects to Multiple Folders

You can import objects to multiple folders that were exported from multiple folders. For example, you exported objects from folders SRC_F1, SRC_F2, and SRC_F3, and you want to import them to target folders TGT_F1, TGT_F2, TGT_F3 in repository TGT_REPO1. You might create a control file with the following attributes:
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="mulfolders" APPLY_LABEL_NAME="L1">
 <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1 TARGETREPOSITORYNAME="TGT_REPO1"/> <FOLDERMAP SOURCEFOLDERNAME="SRC_F2" SOURCEREPOSITORYNAME="SRC_REPO2" TARGETFOLDERNAME="TGT_F2" TARGETREPOSITORYNAME="TGT_REPO1"/> <FOLDERMAP SOURCEFOLDERNAME="SRC_F3" SOURCEREPOSITORYNAME="SRC_REPO3" TARGETFOLDERNAME="TGT_F3" TARGETREPOSITORYNAME="TGT_REPO1"/> <RESOLVECONFLICT> <TYPEOBJECT OBJECTTYPENAME = "SESSIONCONFIG" RESOLUTION="REUSE"/> </RESOLVECONFLICT>
</IMPORTPARAMS>
Importing Specific Objects

You can choose the objects you want to import. For example, you exported multiple object types to an XML file. You want to import only mappings, and respective sources and targets, to a folder. You might create a control file with the following attributes:
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_TYPEFILTER" APPLY_LABEL_NAME="LABEL_MAPPING_TYPEFILTER">
311
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="REPO_EX1_"/>
 <TYPEFILTER TYPENAME="MAPPING"/> </IMPORTPARAMS>
Reusing and Replacing Dependent Objects

You can import sessions, replace the mappings, and reuse the existing sources and targets in the target folder. For example, you want to replace the mappings and reuse the source definitions, target definitions, and session configuration objects. You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_TYPEFILTER" APPLY_LABEL_NAME="LABEL_SESSION_TYPEFILTER"> <FOLDERMAP SOURCEFOLDERNAME="PMREP_CHECKED_OUT" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="PMREP_CHECKED_OUT_IMPORT_TYPEFILTER_SESSION" TARGETREPOSITORYNAME="REPO_EX_1"/> <TYPEFILTER TYPENAME="SESSION"/> <RESOLVECONFLICT>
 <TYPEOBJECT OBJECTTYPENAME = "MAPPING" RESOLUTION="REPLACE"/>
 <TYPEOBJECT OBJECTTYPENAME = "SOURCE DEFINITION" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME = "TARGET DEFINITION" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME = "SESSIONCONFIG" RESOLUTION="REUSE"/> </RESOLVECONFLICT> </IMPORTPARAMS>
Replacing Invalid Mappings

You can replace invalid mappings and associated child objects that are returned by a query. For example, you want to replace objects returned by the query QUERY_PARENT_RENAME. You might create a control file with the following attributes:
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES"
312
CHECKIN_COMMENTS="PMREP_IMPORT_QUERY_PARENT_REPLACE_CHILD_REUSE" APPLY_LABEL_NAME="LABEL_QUERY_PARENT_RENAME_CHILD_REUSE"> <FOLDERMAP SOURCEFOLDERNAME="PMREP_CHECKED_OUT" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="PMREP_CHECKED_OUT" TARGETREPOSITORYNAME="REPO_EX_1"/> <RESOLVECONFLICT>
 <QUERYOBJECT QUERYNAME="QUERY_PARENT_RENAME" RESOLUTION="REPLACE"/> </RESOLVECONFLICT> </IMPORTPARAMS>
Renaming Objects
You can rename specific objects when object conflicts occur. For example, you want to the rename the objects ADDRESS, ADDRESS1, R_LKP, MAP_MLET, R_S3, WF_RS1. The Repository Service appends the object names with a number. You might create a control file with the following attributes:
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_SPECIFICOBJECT_RENAME" APPLY_LABEL_NAME="LABEL_IMPORT_SPECIFIC_OBJECT_RENAME"> <FOLDERMAP SOURCEFOLDERNAME="SRC_FOLDER1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_FOLDER1" TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>

<SPECIFICOBJECT NAME="ADDRESS" DBDNAME="sol805" OBJECTTYPENAME="Source Definition" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> <SPECIFICOBJECT NAME="ADDRESS1" OBJECTTYPENAME="Target Definition" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> <SPECIFICOBJECT NAME="R_LKP" OBJECTTYPENAME="Lookup Procedure" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> <SPECIFICOBJECT NAME="MAP_MLET" OBJECTTYPENAME="Mapping" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> <SPECIFICOBJECT NAME="R_S3" OBJECTTYPENAME="Session" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> <SPECIFICOBJECT NAME="WF_RS1" OBJECTTYPENAME="Workflow" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/> </RESOLVECONFLICT></IMPORTPARAMS>
313
Copying SAP Mappings and SAP Program Information

You can copy SAP program information when you import SAP mappings. For example, you want to import the SAP mappings and copy the program information associated with the object you are importing to folder TGT_F1. You might create a control file with the following attributes:
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">

<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="Version2 of objects" APPLY_LABEL_NAME="LABEL71_REPLACE_FOLDER" COPY_SAP_PROGRAM="YES"> <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="REPO_EX_1"/> </IMPORTPARAMS>
Applying Default Connection Attributes

You can apply a default connection attribute to a session if a connection is not present in the target repository. For example, no connection exists in target repository REPO_EX_1. You might create a control file with the following attributes:
 <IMPORTPARAMS CHECKIN_AFTER_IMPORT="NO" APPLY_DEFAULT_CONNECTION="YES"> <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="REPO_EX_1"/> <RESOLVECONFLICT> <SPECIFICOBJECT NAME="R_S3" OBJECTTYPENAME="Session" FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="REPLACE"/> <RESOLVECONFLICT> </IMPORTPARAMS>
Resolving Object Conflicts

You can resolve object conflicts for labeled objects in the target repository. For example, you have mappings, mapplets, sources, and targets labeled LBL_MPNG_MPLTS_SRCS_TGTS. You want to replace these objects and label them REPLACE_LBL_MPNG_MPLTS_SRCS_TGTS and reuse all transformations. You might create a control file with the following attributes:
314
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd"> <IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_LABEL_REPLACE" APPLY_LABEL_NAME="REPLACE_LBL_MPNG_MPLTS_SRCS_TGTS" > <FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="REPO_EX_1"/>
 <RESOLVECONFLICT> <LABELOBJECT LABELNAME="LBL_MPNG_MPLTS_SRCS_TGTS" RESOLUTION="REPLACE"/> <TYPEOBJECT OBJECTTYPENAME="Lookup Procedure" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Stored Procedure" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Expression" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Filter" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Aggregator" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Rank" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Normalizer" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Router" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Sequence" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Sorter" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="update strategy" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Custom Transformation" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Transaction control" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="External Procedure" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="Joiner" RESOLUTION="REUSE"/> <TYPEOBJECT OBJECTTYPENAME="SessionConfig" RESOLUTION="REUSE"/> </RESOLVECONFLICT>
</IMPORTPARAMS>
315
Using the Deployment Control File

A deployment control file is an XML file that you use with the DeployFolder and DeployDeploymentGroup pmrep commands to deploy a folder or deployment group. You can create a deployment control file manually to provide parameters for deployment, or you can create a deployment control file with the Copy Wizard. For more information about creating a deployment control file with the Copy Wizard, see Copying Folders and Deployment Groups in the Repository Guide. If you create the deployment control file manually, it must conform to the depcntl.dtd file that is installed with the PowerCenter Client. You include the location of the depcntl.dtd file in the deployment control file. You can specify a deployment timeout in the deployment control file. The deployment timeout is the period of time that pmrep waits to acquire object locks in the target repository. By default, pmrep waits indefinitely until it acquires locks or you cancel the deployment. To cancel a deployment while pmrep is waiting to acquire locks, press Ctrl+C.
Note: You must create the deployment control file manually to use some deployment
parameters such as DEPLOYTIMEOUT. The following is a sample of the depcntl.dtd file:

<!ELEMENT DEPLOYPARAMS (DEPLOYFOLDER?, DEPLOYGROUP?)> <!ATTLIST DEPLOYPARAMS DEFAULTSERVERNAME COPYPROGRAMINFO COPYMAPVARPERVALS COPYWFLOWVARPERVALS COPYWFLOWSESSLOGS COPYDEPENDENCY LATESTVERSIONONLY CHECKIN_COMMENTS DEPLOYTIMEOUT RETAINGENERATEDVAL RETAINSERVERNETVALS CDATA #IMPLIED
(YES | NO) "YES" (YES | NO) "NO" (YES | NO) "NO" (YES | NO) "NO" (YES | NO) "YES" (YES | NO) "NO" CDATA CDATA #IMPLIED "-1"
(YES | NO) "YES" (YES | NO) "YES">
 <!ELEMENT DEPLOYFOLDER (REPLACEFOLDER?, DEPLOYEDFOLDEROWNER?, OVERRIDEFOLDER*)> <!ATTLIST DEPLOYFOLDER NEWFOLDERNAME CDATA #IMPLIED>
 <!ELEMENT REPLACEFOLDER EMPTY> <!ATTLIST REPLACEFOLDER FOLDERNAME RETAINMAPVARPERVALS CDATA #REQUIRED
(YES | NO) "NO"
316
RETAINWFLOWVARPERVALS (YES | NO) "YES" RETAINWFLOWSESSLOGS MODIFIEDMANUALLY (YES | NO) "NO" (YES | NO) "NO"
RETAINORIGFOLDEROWNER (YES | NO) "NO">
 <!ELEMENT OVERRIDEFOLDER EMPTY> <!ATTLIST OVERRIDEFOLDER SOURCEFOLDERNAME SOURCEFOLDERTYPE TARGETFOLDERNAME TARGETFOLDERTYPE MODIFIEDMANUALLY CDATA #REQUIRED
(LOCAL | GLOBAL) "LOCAL" CDATA #REQUIRED
(LOCAL | GLOBAL) "LOCAL" (YES | NO) "NO"
 <!ELEMENT DEPLOYGROUP (OVERRIDEFOLDER*, APPLYLABEL?)> <!ATTLIST DEPLOYGROUP CLEARSRCDEPLOYGROUP (YES | NO) "NO">
 <!ELEMENT APPLYLABEL EMPTY> <!ATTLIST APPLYLABEL SOURCELABELNAME SOURCEMOVELABEL TARGETLABELNAME TARGETMOVELABEL CDATA (YES | NO) CDATA YES | NO) #IMPLIED "NO" #IMPLIED "NO">
 <!ELEMENT DEPLOYEDFOLDEROWNER EMPTY> <!ATTLIST DEPLOYEDFOLDEROWNER USERNAME GROUPNAME CDATA CDATA #IMPLIED #IMPLIED>
317
Deployment Control File Parameters

Table 7-4 lists pmrep deployment control file parameters:
Table 7-4. Deployment Control File Elements and Attributes Element DEPLOYPARAMS (Use with DeployFolder and DeployDeploymentGroup) Attribute Name DEFAULTSERVERNAME Required/ Optional Optional Attribute Description Integration Service registered in the target repository to run workflows. For any deployment, you can specify one default server name. Copies SAP installed ABAP program. Copies mapping variable persistent values. Copies workflow variable persistent values. Copies workflow logs. Copies dependency information for objects in mappings. Copies the latest version. Overrides the default comment and adds a comment in the target repository when you copy or deploy an object. You must set LATESTVERSIONONLY to true to use this attribute. Period of time (in seconds) that pmrep attempts to acquire locks on objects in the target repository. A value of 0 fails the copy operation immediately if pmrep cannot obtain a lock. A value of -1 instructs pmrep to wait indefinitely until it acquires locks or the user cancels the operation. Default is -1. Keeps the current value for Sequence Generator or Normalizer transformations. Retains server-network-related values in tasks. Creates a new folder with this name. Names the folder after replacing it.
COPYPROGRAMINFO COPYMAPVARPERVALS COPYWFLOWVARPERVALS COPYWFLOWSESSLOGS COPYDEPENDENCY LATESTVERSIONONLY CHECKIN_COMMENTS
Optional Optional Optional Optional Optional Optional Optional
DEPLOYTIMEOUT
Optional
RETAINGENERATEDVAL
Optional
RETAINSERVERNETVALS DEPLOYFOLDER (Use with DeployFolder) REPLACEFOLDER (Use with DeployFolder) NEWFOLDERNAME FOLDERNAME
Optional Optional Required
318
Table 7-4. Deployment Control File Elements and Attributes Element Attribute Name RETAINMAPVARPERVALS RETAINFLOWVARPERVALS RETAINWFLOWSESSLOGS MODIFIEDMANUALLY Required/ Optional Optional Optional Optional Optional Attribute Description Retains mapping variable persistent values in the target. Retains workflow variable persistent values. Retains workflow session logs in the target. Compares folders if objects in the target folder have been created or modified since the previous deployment. Retains the existing folder owner. pmrep ignores any information provided in the DEPLOYEDFOLDEROWNER element. If deploying a folder, specifies the current folder that shortcuts point to. If deploying a deployment group, specifies the following folders: - Folder or folders that shortcuts point to - Folder or folders containing the deployment group objects Indicates local or global folder. If deploying a folder, specifies the folder that shortcuts point to. If deploying a deployment group, specifies the following folders: - Folder or folders that shortcuts point to - Folder or folders containing the deployment group objects Indicates local or global folder. Compares folders if objects in the target folder have been created or modified since the previous deployment. Use this attribute only with the DeployDeploymentGroup command. Removes objects from the source group after deploying.
RETAINORIGFOLDEROWNE R
Optional
OVERRIDEFOLDER (Use with DeployFolder and DeployDeploymentGroup)
SOURCEFOLDERNAME
Required
SOURCEFOLDERTYPE TARGETFOLDERNAME
Optional Required
TARGETFOLDERTYPE MODIFIEDMANUALLY
Optional Optional
DEPLOYGROUP (Use with DeployDeploymentGroup)
CLEARSRCDEPLOYGROUP
Optional
319
Table 7-4. Deployment Control File Elements and Attributes Element APPLYLABEL (Use with DeployDeploymentGroup) Attribute Name SOURCELABELNAME Required/ Optional Optional Attribute Description Applies a label to all the objects in the source group. Moves the label from a different version of the object in the source group to the deployment group version of the object. If the Repository Agent detects the label is applied to another version of the same object, you can choose to move the label to the selected version of the object. Applies a label to all the objects deployed to the target repository. Moves the label from a different version of the object in the target group to the deployment group version of the object. If the Repository Agent detects the label is applied to another version of the same object, you can choose to move the label to the latest version of the object. Owner of the deployed folder or deployment group in the target repository. Group owner of the deployed folder or deployment group in the target repository.
SOURCEMOVELABEL
Optional
TARGETLABELNAME TARGETMOVELABEL
Optional Optional
DEPLOYEDFOLDEROWNER (Use with DeployFolder and DeployDeploymentGroup)
USERNAME
Optional
GROUPNAME
Optional
320
Deployment Control File Examples

The parameters you specify in the deployment control file code determine the actions that occur when you execute the DeployFolder or DeployDeploymentGroup commands in pmrep. The following examples discuss instances in which you use the DeployFolder and DeployDeploymentGroup commands with a deployment control file.
Deploying the Latest Version of a Folder

You can deploy the latest version of a folder and include all dependencies. For example, you need to retain the current values in a Sequence Generator transformation, and you need to point the shortcuts from the sc_folder to the new_sc_folder. After you copy the folder, you want to rename it to new_year. You might create a control file with following attributes:
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE DEPLOYPARAMS SYSTEM "depcntl.dtd"> <DEPLOYPARAMS DEFAULTSERVERNAME ="info7261" COPYPROGRAMINFO ="NO" COPYWFLOWVARPERVALS ="NO" COPYWFLOWSESSLOGS ="NO" COPYDEPENDENCY ="YES" LATESTVERSIONONLY = "NO">
<REPLACEFOLDER FOLDERNAME ="NEW_YEAR" RETAINVARPERVALS ="YES"/>
<OVERRIDEFOLDER SOURCEFOLDERNAME ="SC_FOLDER" OVERRIDEFOLDERNAME ="NEW_SC_FOLDER"/>
</DEPLOYPARAMS>
Deploying the Latest Version of a Deployment Group

You can deploy the latest version of a deployment group and apply a label to the objects in the deployment group. For example, you want to apply the label NEW_SRC_LABEL_NAME to all objects in the source group, and NEW_TGT_LABEL_NAME to all objects in the target group. You might create a control file with following attributes:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE DEPLOYPARAMS SYSTEM "depcntl.dtd"> <DEPLOYPARAMS DEFAULTSERVERNAME="dg_sunqa2_51880" COPYPROGRAMINFO="YES" COPYMAPVARPERVALS="YES" COPYWFLOWVARPERVALS="YES"
321
COPYWFLOWSESSLOGS="NO" COPYDEPENDENCY="YES" LATESTVERSIONONLY="YES" RETAINGENERATEDVAL="YES" RETAINSERVERNETVALS="YES"> <DEPLOYGROUP CLEARSRCDEPLOYGROUP="NO"> <OVERRIDEFOLDER SOURCEFOLDERNAME="SRC_FOLDER1" SOURCEFOLDERTYPE="LOCAL" TARGETFOLDERNAME="TGT_FOLDER1" TARGETFOLDERTYPE="LOCAL"/> <APPLYLABEL SOURCELABELNAME="NEW_SRC_LABEL_NAME" SOURCEMOVELABEL="YES" TARGETLABELNAME="NEW_TGT_LABEL_NAME" TARGETMOVELABEL="YES" /> </DEPLOYGROUP> </DEPLOYPARAMS>
Listing Multiple Source and Target Folders

Use the OVERRIDEFOLDER element in the control file to list multiple source and target folders. Use the SOURCEFOLDERNAME and TARGETFOLDERNAME attributes to specify the following folders in the source and target repositories:

The folder or folders that shortcuts point to The folder or folders containing the deployment group objects
When you run the pmrep command, DeployDeploymentGroup, the deploy process picks the right target folder to use after checking the objects in the deployment group. For example, if a deployment group contains objects in two folders with shortcuts to a third folder, you can create a control file with three occurrences of OVERRIDEFOLDER. The following sample control file deploys a deployment group that contains objects in the folders OBJECTFOLDER1 and OBJECTFOLDER2 that contain shortcuts pointing to the folder SHAREDSHORTCUT:
<!DOCTYPE DEPLOYPARAMS SYSTEM "depcntl.dtd"> > <DEPLOYPARAMS DEFAULTSERVERNAME="dg_sun_71099" > COPYPROGRAMINFO="YES" COPYMAPVARPERVALS="YES" > COPYWFLOWVARPERVALS="YES" COPYWFLOWSESSLOGS="NO" > COPYDEPENDENCY="YES" LATESTVERSIONONLY="YES" > RETAINGENERATEDVAL="YES" RETAINSERVERNETVALS="YES"> > > <DEPLOYGROUP CLEARSRCDEPLOYGROUP="NO"> <OVERRIDEFOLDER
> SOURCEFOLDERNAME="OBJECTFOLDER1" > SOURCEFOLDERTYPE="LOCAL" > TARGETFOLDERNAME="OBJECTFOLDER1" > TARGETFOLDERTYPE="LOCAL"/>
322
>
<OVERRIDEFOLDER
> SOURCEFOLDERNAME="OBJECTFOLDER2" > SOURCEFOLDERTYPE="LOCAL" > TARGETFOLDERNAME="OBJECTFOLDER2" > TARGETFOLDERTYPE="LOCAL"/> > <OVERRIDEFOLDER
> SOURCEFOLDERNAME="SHAREDSHORTCUTS" > SOURCEFOLDERTYPE="GLOBAL" > TARGETFOLDERNAME="SHAREDSHORTCUTS" > TARGETFOLDERTYPE="GLOBAL"/> > </DEPLOYGROUP>
> </DEPLOYPARAMS>
323
Tips
Use the -n option when you use the pmrep commands Updatesrcprefix or Updatetargprefix. When you include the -n option, you must enter the name of the source or target instance for the -t option. The source or target instance name must match the name displayed in the session properties or the name output by the Listtablesbysess command. Use the -n option to use the Listtablesbysess command with the Updatesrcprefix or Updatetargprefix commands in a shell script if the source and target instance names match. Also, use the -n option to update a source even if the session uses a shortcut to a mapping. When using the pmrep command ListObjects, enter a character or set of characters that is not used in repository object names for the column separator, end of record indicator, and end of listing indicator. When you enter characters to separate records and columns, and to indicate the end of the listing, use characters that are not included in repository object names. This helps you use a shell script to parse the object metadata. In pmrep, use the -v option when restoring a repository that uses an external directory service for user management. When you include the -v option with Restore, you can retain the external directory service registration for the repository. If you do not enter this option with the valid administrator user name and password, the restored repository defaults to repository authentication mode and you lose the login name-user name mappings.
324
Index
A
AbortTask (pmcmd) description 143 AbortWorkflow (pmcmd) description 145 AddDomainLink (infacmd) description 25 AddDomainNode (infacmd) description 27 AddLicense (infacmd) description 28 AddNodeResource (infacmd) description 30 AddPrivilege (pmrep) description 198 AddToDeploymentGroup (pmrep) description 199 AddUserToGroup (pmrep) description 201 application services disabling using infacmd 55 enabling using infacmd 60 getting status using infacmd 71 removing using infacmd 90 ApplyLabel (pmrep) description 202 AssignedToLicense (infacmd) description 32
AssignLicense (infacmd) description 33 AssignRSToWSHubService (infacmd) description 35
B
BackUp (pmrep) description 204 BackupDomain (infasetup) description 117
C
CheckIn (pmrep) description 206 CleanUp (pmrep) description 207 ClearDeploymentGroup (pmrep) description 208 command line mode for pmcmd connecting 134 Connect (pmcmd) description 147 Connect (pmrep) description 209 connect string examples 192
325
syntax 192 connectivity connect string examples 192 control file deployment 316 object import 303 ObjectImport XML example 307 ConvertLogFile (infacmd) description 37 Create (pmrep) description 211 CreateConnection (pmrep) description 212 CreateDeploymentGroup (pmrep) description 217 CreateFolder (pmrep) description 218 CreateGrid (infacmd) description 38 CreateGroup (pmrep) description 220 CreateIntegrationService (infacmd) description 39 CreateLabel (pmrep) description 221 CreateRepositoryService (infacmd) description 46 CreateUser (pmrep) description 222 CreateWSHubService (infacmd) description 50
description 227 depcntl.dtd listing 316 DeployDeploymentGroup (pmrep) description 228 DeployFolder (pmrep) description 230 deploying objects depcntl.dtd 316 deployment groups listing multiple folders 322 DisableNodeResource (infacmd) description 53 DisableService (infacmd) description 55 DisableServiceProcess (infacmd) description 56 Disconnect (pmcmd) description 148 domain password changing using infacmd 99 domains backing up using infasetup 117 creating using infasetup 119 linking using infacmd 25 listing linked domains using infacmd 77 removing links using infacmd 83 restoring using infasetup 127 DTD file plug-in template 266
D
DB2 See IBM DB2 DefineDomain (infasetup) description 119 DefineGatewayNode (infasetup) description 122 DefineWorkerNode (infasetup) description 124 Delete (pmrep) description 223 DeleteConnection (pmrep) description 224 DeleteDeploymentGroup (pmrep) description 225 DeleteFolder (pmrep) description 226 DeleteLabel (pmrep)
326 Index
E
EditUser (pmrep) description 232 EnableNodeResource (infacmd) description 58 EnableService (infacmd) description 60 EnableServiceProcess (infacmd) description 61 environment variables INFA_CLIENT_RESILIENCE_TIMEOUT 8 INFA_CODEPAGENAME 9 INFA_DEFAULT_DATABASE_PASSWORD 10 INFA_DEFAULT_DOMAIN 11 INFA_DEFAULT_DOMAIN_PASSWORD 12 INFA_DEFAULT_DOMAIN_USER 13 INFA_REPCNX_INFO 14 INFATOOL_DATEFORMAT 15 error messages
fetching using infacmd 62 ExecuteQuery (pmrep) description 234 Exit (pmrep) description 236 external security module registering 266 external security modules unregistering 283
description 74 grids creating using infacmd 38 listing nodes using infacmd 78 removing using infacmd 84 updating assigned nodes using infacmd 101
H
Help (infacmd) description 76 Help (pmcmd) description 161 Help (pmrep) description 239
F
FindCheckout (pmrep) description 237 folders deleting 226 deploying 230 modifying 258
I
IBM DB2 connect string example 192 importing objects impcntl.dtd 303 ObjectImport XML example 307 INFA_CLIENT_RESILIENCE_TIMEOUT configuring 8 INFA_CODEPAGENAME configuring 9 INFA_DEFAULT_DATABASE_PASSWORD configuring 10 INFA_DEFAULT_DOMAIN configuring 11 INFA_DEFAULT_DOMAIN_PASSWORD configuring 12 INFA_DEFAULT_DOMAIN_USER configuring 13 INFA_REPCNX_INFO configuring 14 infacmd domains, linking 25 domains, listing linked domains 77 domains, removing links 83 error messages, fetching 62 gateway information, updating 100 grids, creating 38 grids, listing nodes 78 grids, removing 84 grids, updating assigned nodes 101 help 76 Integration Service options 41 Integration Services, creating 39
G
gateway updating information using infacmd 100 GetLastError (infacmd) description 62 GetLog (infacmd) description 64 GetRunningSessionsDetails (pmcmd) description 150 GetServiceDetails (pmcmd) description 152 GetServiceOption (infacmd) description 67 GetServiceProcessOption (infacmd) description 69 GetServiceProcessStatus (infacmd) description 70 GetServiceProperties (pmcmd) description 154 GetServiceStatus (infacmd) description 71 GetSessionLog (infacmd) description 72 GetSessionStatistics (pmcmd) description 155 GetTaskDetails (pmcmd) description 157 GetWorkflowDetails (pmcmd) description 159 GetWorkflowLog (infacmd)
Index
327
Integration Services, updating 102 licenses, adding 28 licenses, assigning to services 33 licenses, displaying information 91 licenses, listing 79 licenses, listing services 32 licenses, removing 85 licenses, unassigning 93 licenses, updating 104 log events, fetching 64 log events, purging 82 log files, converting to binary 37 nodes, adding to domains 27 nodes, disassociating from domains 97 nodes, removing 87 nodes, shutting down 92 nodes, updating 105 passwords, updating 99 pinging objects 81 Repository Service options 47 Repository Services, creating 46 Repository Services, updating 107 resources, adding to nodes 30 resources, disabling on nodes 53 resources, enabling on nodes 58 resources, listing for nodes 80 resources, removing from nodes 88 return codes 21 service options, fetching 67 service process options 44 service process options, fetching 69 service process status, fetching 70 service processes, disabling 56 service processes, enabling 61 service processes, updating 109 service status, fetching 71 services, disabling 55 services, enabling 60 services, removing 90 session logs, fetching 72 Web Service Hub Service options 51 Web Service Hub Services, associating a repository 35 Web Service Hub Services, creating 50 Web Service Hub Services, disassociating a repository 95 Web Service Hub Services, updating 111 workflow logs, fetching 74 infasetup domains, backing up 117 domains, defining 119 domains, restoring 127
gateway nodes, defining 122 gateway nodes, updating 129 return codes 114 worker nodes, defining 124 worker nodes, updating 131 INFATOOL_DATEFORMAT configuring 15 Integration Service creating using infacmd 39 disabling using infacmd 55 enabling using infacmd 60 getting status using infacmd 71 removing using infacmd 90 updating using infacmd 102 interactive mode for pmcmd connecting 136 setting defaults 136
K
KillUserConnection (pmrep) description 240
L
labels creating 221 deleting 227 licenses adding using infacmd 28 assigning using infacmd 33 displaying using infacmd 91 listing services using infacmd 32 listing using infacmd 79 removing using infacmd 85 unassigning using infacmd 93 updating using infacmd 104 ListAllGroups (pmrep) description 241 ListAllPrivileges (pmrep) description 242 ListAllUsers (pmrep) description 243, 244 ListDomainLinks (infacmd) description 77 ListGridNodes (infacmd) description 78 ListGroupsForUser (pmrep) description 244 ListLicenses (infacmd)
328
Index
description 79 ListNodeResources (infacmd) description 80 ListObjectDependencies (pmrep) description 245 ListObjects (pmrep) description 248 listing folders 252 transformation types 251 ListTablesBySess (pmrep) description 254 ListUserConnections (pmrep) description 256 local parameter files using with pmcmd StartWorkflow 175 log events converting using infacmd 37 fetching using infacmd 64 purging using infacmd 82 truncating using pmrep 278 LsPrivileges (pmrep) description 257
objects checking in 206 exporting 260 importing 262 Oracle connect string syntax 192 OVERRIDEFOLDER sample control file 322
P
parameter files using with pmcmd StartTask 172 using with pmcmd StartWorkflow 175 passwords changing using infacmd 99 persistent input file creating with pmrep 301 Ping (infacmd) description 81 PingService (pmcmd) description 162 plug-ins XML templates 266 pmcmd command line mode 134 commands, list of 140 folders, designating for executing commands 167 folders, designating no default folder 183 help 161 Integration Service, connecting to 147 Integration Service, disconnecting from 148 Integration Service, getting properties 154 Integration Service, pinging 162 interactive mode 136 interactive mode, exiting from 149 nowait mode, setting 168 parameter files 172, 175 return codes 135 script files 138 service settings, getting 170 session statistics, getting 155 sessions, getting details about 150 tasks, aborting 143 tasks, completing before returning the prompt 185 tasks, getting details about 152, 157 tasks, starting 171 tasks, stopping 177 version, displaying 184 wait mode, setting 169 workflows, aborting 145
Index 329
M
Microsoft SQL Server connect string syntax 192 ModifyFolder (pmrep) description 258
N
native connect string See connect string nodes adding to domains using infacmd 27 defining gateway using infasetup 122 defining worker using infasetup 124 disassociating from domains infacmd 97 updating gateway using infasetup 129 updating worker using infasetup 131 Notify (pmrep) description 259
O
ObjectExport (pmrep) description 260 ObjectImport (pmrep) description 262
workflows, determining if running 187 workflows, getting details about 152, 159 workflows, recovering 163 workflows, removing from a schedule 181 workflows, scheduling 165 workflows, starting 174 workflows, stopping 179 pmrep checked-out objects, listing 237 checkouts, undoing 279 command line mode 190 connection information, showing 276 connection name, changing 277 connections, creating 212 connections, deleting 224 connections, updating 284 deployment control parameters 318 deployment groups, adding objects to 199 deployment groups, clearing objects from 208 deployment groups, creating 217 deployment groups, deleting 225 deployment groups, deploying 228 email addresses, updating 286 folder properties, modifying 258 folders, creating 218 folders, deleting 226 folders, deploying 230 folders, listing 252 folders, modifying properties 258 groups, adding users to 201 groups, creating 220 groups, listing 241 groups, listing for user 244 groups, removing 271 groups, removing users from 274 help 239 interactive mode 190 interactive mode, exiting 236 interactive mode, exiting from 236 labels, applying 202 labels, creating 221 labels, deleting 227 logs, deleting 278 notification messages, sending 259 object dependencies, listing 245 object import control parameters 305 objects, checking in 206 objects, exporting 260 objects, importing 262 objects, listing 248 objects, validating 294
overview 190 persistent input files, creating 301 plug-ins, registering 265 plug-ins, unregistering 282 privileges, adding 198 privileges, listing 242 privileges, listing for user or group 257 privileges, removing 272 queries, executing 234 repositories, backing up 204 repositories, connecting to 209 repositories, creating 211 repositories, deleting 223 repositories, registering 263 repositories, restoring 268 repositories, unregistering 280 repositories, upgrading 293 repository connection file, specifying 14 repository statistics, updating 291 resources, cleaning up 207 script files 192 scripts, running 275 sequence values, updating 287 table owner names, updating 289 tables, listing by session 254 target table name prefixes, updating 292 user connections, listing 256 user connections, terminating 240 user information, editing 232 user properties, editing 232 users, adding to repositories 222 users, creating 222 users, listing 243, 244, 243 users, registering 267 users, removing 273 users, removing from groups 274 version information, displaying 297 post-session email updating addresses with pmrep 286 privileges removing 272 PurgeLog (infacmd) description 82
Q
queries executing 234
330
Index
R
RecoverWorkflow (pmcmd) description 163 Register (pmrep) description 263 registering a user 267 plug-in using pmrep 265 security module using pmrep 266 RegisterPlugin (pmrep) description 265 RegisterUser (pmrep) description 267 RemoveDomainLink (infacmd) description 83 RemoveGrid (infacmd) description 84 RemoveLicense (infacmd) description 85 RemoveNode (infacmd) description 87 RemoveNodeResource (infacmd) description 88 RemoveService (infacmd) description 90 repositories backing up using pmrep 204 creating relational 212 deleting details from 278 registering 263 unregistering 280 Repository Service creating using infacmd 46 disabling using infacmd 55 enabling using infacmd 60 getting status using infacmd 71 removing using infacmd 90 updating using infacmd 107 resources defining using infacmd 30 disabling using infacmd 53 enabling using infacmd 58 removing using infacmd 88 viewing using infacmd 80 Restore (pmrep) description 268 RestoreDomain (infasetup) description 127 restoring repositories using pmrep Restore 268
return codes infacmd 21 infasetup 114 pmcmd 135 RmGroup (pmrep) description 271 RmPrivilege (pmrep) description 272 RmUser (pmrep) description 273 RmUserFromGroup (pmrep) description 274 Run (pmrep) description 275
S
ScheduleWorkflow (pmcmd) description 165 script files running 275 service options fetching using infacmd 67 service process options fetching using infacmd 69 session logs fetching using infacmd 72 SetFolder (pmcmd) description 167 SetNoWait (pmcmd) description 168 SetWait (pmcmd) description 169 ShowConnectionInfo (pmrep) description 276 ShowLicense (infacmd) description 91 ShowSettings (pmcmd) description 170 ShutdownNode (infacmd) description 92 StartTask (pmcmd) description 171 using a parameter file 172 StartWorkflow (pmcmd) description 174 using a parameter file 175 statistics updating repository 291 StopTask (pmcmd) description 177
Index 331
StopWorkflow (pmcmd) description 179 SwitchConnection (pmrep) description 277 syntax command line programs 3
T
table owner name updating with pmrep 289 TruncateLog (pmrep) description 278
U
UnassignLicense (infacmd) description 93 UnassignRSWSHubService (infacmd) description 95 UnassociateDomainNode (infacmd) description 97 UndoCheckout (pmrep) description 279 Unregister (pmrep) description 280 UnregisterPlugin (pmrep) description 282 UnscheduleWorkflow (pmcmd) description 181 UnsetFolder (pmcmd) description 183 UpdateConnection (pmrep) description 284 UpdateDomainPassword (infacmd) description 99 UpdateEmailAddr (pmrep) description 286 UpdateGatewayInfo (infacmd) description 100 UpdateGatewayNode (infasetup) description 129 UpdateGrid (infacmd) description 101 UpdateIntegrationService (infacmd) description 102 UpdateLicense (infacmd) description 104 UpdateNodeOptions (infacmd) description 105
UpdateRepositoryService (infacmd) description 107 UpdateSeqGenVals (pmrep) description 287 UpdateServiceProcess (infacmd) description 109 UpdateSrcPrefix (pmrep) description 289 updating non-reusable sessions 289 UpdateStatistics (pmrep) description 291 UpdateTargetPrefix (pmrep) description 292 updating non-reusable sessions 292 UpdateWorkerNode (infasetup) description 131 UpdateWSHubService (infacmd) description 111 Upgrade (pmrep) description 293
V
Validate (pmrep) description 294 validating objects with pmrep 294 Version (pmcmd) description 184 Version (pmrep) description 297
W
WaitTask (pmcmd) description 185 WaitWorkflow (pmcmd) description 187 Web Service Hub Services associating a repository using infacmd 35 creating using infacmd 50 disassociating a repository using infacmd 95 updating using infacmd 111 workflow logs fetching using infacmd 74 workflows recovering using pmcmd syntax 163
332
Index
X
XML file plug-in templates 266
Index
333
334
Index

PC 81 CommandLineReference

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

PC 81 CommandLineReference

Transféré par

Droits d'auteur :

Formats disponibles

Command Line Reference

Chapter 1: Using the Command Line Programs . . . . . . . . . . . . . . . . . . 1

Chapter 2: Configuring Environment Variables . . . . . . . . . . . . . . . . . . 5

Chapter 3: infacmd Commands Reference . . . . . . . . . . . . . . . . . . . . . 19

Chapter 4: infasetup Commands Reference . . . . . . . . . . . . . . . . . . . 113

Chapter 5: pmcmd Commands Reference . . . . . . . . . . . . . . . . . . . . 133

Chapter 6: pmrep Commands Reference . . . . . . . . . . . . . . . . . . . . . 189

Chapter 7: Working with pmrep Files . . . . . . . . . . . . . . . . . . . . . . . . 299

About This Book

italicized text boldfaced text

Note: Tip: Warning:

Other Informatica Resources

Visiting Informatica Customer Portal

Visiting the Informatica Web Site

Visiting the Informatica Developer Network

Visiting the Informatica Knowledge Base

Obtaining Technical Support

Use the following email addresses to contact Informatica Technical Support:

Toll Free 877 463 2435

Toll Free 00 800 4632 4357

Standard Rate United States: 650 385 5800

Using the Command Line Programs

Entering Options and Arguments

Chapter 1: Using the Command Line Programs

<x> <x | y >

Chapter 1: Using the Command Line Programs

Configuring Environment Variables

Environment Variable INFA_CLIENT_RESILIENCE_TIMEOUT

infacmd pmcmd pmrep infacmd

Chapter 2: Configuring Environment Variables

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

Chapter 2: Configuring Environment Variables

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

To configure INFA_DEFAULT_DATABASE_PASSWORD on UNIX: 1.

At the command line, type:

pmpasswd returns the encrypted password.

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

At the command line, type:

pmpasswd returns the encrypted password.

Chapter 2: Configuring Environment Variables

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

To configure INFA_DEFAULT_DOMAIN_PASSWORD on UNIX: 1.

At the command line, type:

pmpasswd returns the encrypted password.

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

At the command line, type:

pmpasswd returns the encrypted password.

Chapter 2: Configuring Environment Variables

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

In a DOS shell, type:

not for the machine.

Chapter 2: Configuring Environment Variables

In a UNIX C shell environment, type:

In a UNIX Bourne shell environment, type:

Encrypting Repository Passwords