PC 81 CommandLineReference
PC 81 CommandLineReference
PC 81 CommandLineReference
Informatica PowerCenter®
(Version 8.1)
Informatica PowerCenter Command Line Reference
Version 8.1
April 2006
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, <[email protected]>. 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.
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
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
v 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
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
x Table of Contents
List of Tables
Table 1-1. Syntax Notation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Table 2-1. Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Table 3-1. infacmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 3-2. AddDomainLink Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 3-3. AddDomainNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 3-4. AddLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 3-5. AddNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 3-6. AssignedToLicense Options and Arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 3-7. AssignLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Table 3-8. AssignRSToWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . 35
Table 3-9. ConvertLogFile Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 3-10. CreateGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 3-11. CreateIntegrationService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 3-12. Integration Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Table 3-13. Integration Service Process Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Table 3-14. CreateRepositoryService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 3-15. Repository Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Table 3-16. CreateWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 3-17. Web Services Hub Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 3-18. DisableNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 3-19. DisableService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 3-20. DisableServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 3-21. EnableNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table 3-22. EnableService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 3-23. EnableServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 3-24. GetLastError Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 3-25. GetLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 3-26. GetServiceOption Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 3-27. GetServiceProcessOption Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 3-28. GetServiceProcessStatus Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 70
Table 3-29. GetServiceStatus Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 3-30. GetSessionLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Table 3-31. GetWorkflowLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Table 3-32. Help Option and Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Table 3-33. ListDomainLinks Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Table 3-34. ListGridNodes Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Table 3-35. ListLicenses Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Table 3-36. ListNodeResources Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Table 3-37. Ping Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 3-38. PurgeLog Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
List of Tables xi
Table 3-39. RemoveDomainLink Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 3-40. RemoveGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 3-41. RemoveLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 3-42. RemoveNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Table 3-43. RemoveNodeResource Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Table 3-44. RemoveService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Table 3-45. ShowLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Table 3-46. ShutdownNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Table 3-47. UnassignLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Table 3-48. UnassignRSWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . 95
Table 3-49. UnassociateDomainNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 97
Table 3-50. UpdateDomainPassword Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . 99
Table 3-51. UpdateGatewayInfo Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Table 3-52. UpdateGrid Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Table 3-53. UpdateIntegrationService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . .102
Table 3-54. UpdateLicense Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
Table 3-55. UpdateNodeOptions Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Table 3-56. UpdateRepositoryService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . .107
Table 3-57. UpdateServiceProcess Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . .109
Table 3-58. UpdateWSHubService Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . .111
Table 4-1. infasetup Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116
Table 4-2. BackupDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
Table 4-3. DefineDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Table 4-4. DefineGatewayNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
Table 4-5. DefineWorkerNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Table 4-6. Help Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Table 4-7. RestoreDomain Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Table 4-8. UpdateGatewayNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Table 4-9. UpdateWorkerNode Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Table 5-1. pmcmd Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Table 5-2. Setting Defaults for Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Table 5-3. pmcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
Table 5-4. aborttask Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Table 5-5. abortworkflow Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Table 5-6. connect Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Table 5-7. getrunningsessionsdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . .150
Table 5-8. getservicedetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
Table 5-9. getserviceproperties Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
Table 5-10. getsessionstatistics Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
Table 5-11. gettaskdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
Table 5-12. getworkflowdetails Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
Table 5-13. help Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
Table 5-14. pingservice Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
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:
italicized monospaced text 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.
Warning: The following paragraph notes situations where you can overwrite
or corrupt data, unless you follow the specified procedure.
bold monospaced text This is an operating system command you enter from a prompt to
run a task.
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
Preface xvii
Use the following email addresses to contact Informatica Technical Support:
♦ [email protected] for technical inquiries
♦ [email protected] 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 Europe / Middle East / Africa Asia / Australia
xviii Preface
Chapter 1
1
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.
Syntax Notation
Table 1-1 describes the notation used in this book to show the syntax for all PowerCenter
command line programs:
Convention Description
-x 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.
<x> Required option. If you omit a required option, the command line program returns
an error message.
<x | y > 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.
{x | y} In pmrep, curly brackets denote groupings of required options, as in the following
example:
killuserconnection
{-i <connection_id> |
-n <user_name> |
-a (kill all)}
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>> When a set contains subsets, the superset is indicated with bold brackets < >. A
bold pipe symbol (|) separates the subsets.
(text) 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 3
4 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
5
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:
Command
Environment Variable Line Description
Programs
INFA_CLIENT_RESILIENCE_TIMEOUT infacmd Limits the number of seconds you want the command
pmcmd line programs to spend establishing a connection to the
pmrep domain or service. For more information, see
“INFA_CLIENT_RESILIENCE_TIMEOUT” on page 8.
INFA_CODEPAGENAME pmcmd Configures the character set pmcmd and pmrep use.
pmrep For more information, see “INFA_CODEPAGENAME”
on page 9.
INFA_DEFAULT_DATABASE_PASSWORD infasetup Stores the default user name password for the domain
configuration database. For more information, see
“INFA_DEFAULT_DATABASE_PASSWORD” on
page 10.
INFA_DEFAULT_DOMAIN infacmd Stores the default domain name. For more information,
pmcmd see “INFA_DEFAULT_DOMAIN” on page 11.
pmrep
INFA_DEFAULT_DOMAIN_PASSWORD infacmd Stores the default user name password for the domain.
For more information, see
“INFA_DEFAULT_DOMAIN_PASSWORD” on page 12.
INFA_DEFAULT_DOMAIN_USER infacmd Stores the default user name for the domain. For more
information, see “INFA_DEFAULT_DOMAIN_USER” on
page 13.
INFA_REPCNX_INFO pmrep Stores the name of the repository connection file. For
more information, see “INFA_REPCNX_INFO” on
page 14.
INFATOOL_DATEFORMAT pmcmd Configures the way pmcmd displays the date and time.
For more information, see “INFATOOL_DATEFORMAT”
on page 15.
Command
Environment Variable Line Description
Programs
<Password_Environment_Variable> pmcmd Encrypts and stores the repository password. For more
pmrep information, see “Encrypting Repository Passwords” on
page 16.
<User_Name_Environment_Variable> pmcmd Stores the repository user name. For more information,
pmrep see “Setting the Repository User Name” on page 17.
Overview 7
INFA_CLIENT_RESILIENCE_TIMEOUT
Command Line Programs:
infacmd
pmcmd
pmrep
export INFA_CLIENT_RESILIENCE_TIMEOUT
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.
export INFA_CODEPAGENAME
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 9
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.
export INFA_DEFAULT_DATABASE_PASSWORD
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.
export INFA_DEFAULT_DOMAIN
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.
export INFA_DEFAULT_DOMAIN_PASSWORD
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.
export INFA_DEFAULT_DOMAIN_USER
INFA_DEFAULT_DOMAIN_USER 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.
export INFA_REPCNX_INFO
Note: If you run multiple pmrep scripts, set this environment variable for the DOS shell,
not for the machine.
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.
export INFATOOL_DATEFORMAT
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
Command Line Programs:
pmcmd
pmrep
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.
export <Password_Environment_Variable>
You can assign the environment variable any valid UNIX name.
For pmcmd and pmrep, you can create an environment variable to store the repository user
name.
export <User_Name_Environment_Variable>
You can assign the environment variable any valid UNIX name.
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.
infacmd Commands
Reference
This chapter includes the following topics:
♦ 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.
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.
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.
Command Description
AddDomainLink Records connection information so that you can access another domain. For more
information, see “AddDomainLink” on page 25.
AddDomainNode Adds a node to a domain. For more information, see “AddDomainNode” on page 27.
AddLicense Adds a license to a domain. For more information, see “AddLicense” on page 28.
AssignedToLicense Lists the services assigned to a license. For more information, see
“AssignedToLicense” on page 32.
AssignRSToWSHubService Associates a repository with a Web Services Hub Service in a domain. For more
information, see “AssignRSToWSHubService” on page 35.
ConvertLogFile Converts binary log files to readable text files. For more information,
see“ConvertLogFile” on page 37.
CreateGrid Creates a grid and assigns nodes to the grid. For more information, see “CreateGrid”
on page 38.
CreateWSHubService Creates a Web Services Hub Service in a domain. For more information, see
“CreateWSHubService” on page 50.
DisableService Disables the service corresponding to service name. For more information, see
“DisableService” on page 55.
DisableServiceProcess Disables the service process on a specified node. For more information, see
“DisableServiceProcess” on page 56.
EnableNodeResource Enables a user defined or connection resource. For more information, see
“EnableNodeResource” on page 58.
EnableService Enables the service corresponding to the service name. For more information, see
“EnableService” on page 60.
EnableServiceProcess Enables the service process on a specified node. For more information, see
“EnableServiceProcess” on page 61.
Command Description
GetLastError Fetches most recent error messages for an application service. For more information,
see “GetLastError” on page 62.
GetLog Fetches log events based on criteria you provide. For more information, see “GetLog”
on page 64.
GetServiceOption Fetches the value of a service property. For more information, see
“GetServiceOption” on page 67.
GetServiceProcessOption Returns the value of the service process property. For more information, see
“GetServiceProcessOption” on page 69.
GetServiceProcessStatus Returns the state of a service process. For more information, see
“GetServiceProcessStatus” on page 70.
GetServiceStatus Returns the state of a service. For more information, see “GetServiceStatus” on
page 71.
GetSessionLog Fetches log events for the session you specify. For more information, see
“GetSessionLog” on page 72.
GetWorkflowLog Fetches log events for the workflow you specify. For more information, see
“GetWorkflowLog” on page 74.
Help Returns the syntax for the command you specify. Lists the options for the command.
For more information, see “Help” on page 76.
ListDomainLinks Lists the domains that the local domain can connect to. For more information, see
“ListDomainLinks” on page 77.
ListGridNodes Lists the nodes assigned to a grid. For more information, see “ListGridNodes” on
page 78.
ListLicenses Lists licenses in a domain. For more information, see “ListLicenses” on page 79.
ListNodeResources Lists all resources defined for node. For more information, see “ListNodeResources”
on page 80.
Ping Pings a domain or application service. For more information, see “Ping” on page 81.
PurgeLog Purges log events based on criteria you provide. For more information, see
“PurgeLog” on page 82.
RemoveDomainLink Removes connection information so that you can no longer access another domain.
For more information, see “RemoveDomainLink” on page 83.
RemoveGrid Removes a grid from a domain. For more information, see “RemoveGrid” on page 84.
RemoveLicense Removes a license from a domain. For more information, see “RemoveLicense” on
page 85.
RemoveNode Removes a node from a domain. For more information, see “RemoveNode” on
page 87.
infacmd Commands 23
Table 3-1. infacmd Commands
Command Description
RemoveService Removes an application service from a domain. For more information, see
“RemoveService” on page 90.
ShowLicense Displays license information. For more information, see “ShowLicense” on page 91.
ShutdownNode Shuts down a node. For more information, see “ShutdownNode” on page 92.
UnassignLicense Removes a license from an application service. For more information, see
“UnassignLicense” on page 93.
UnassignRSWSHubService Disassociates a repository from a Web Services Hub Service in a domain. For more
information, see “UnassignRSWSHubService” on page 95.
UnassociateDomainNode Disassociates a node from its address. For more information, see
“UnassociateDomainNode” on page 97.
UpdateDomainPassword Updates the password for the domain administrator. For more information, see
“UpdateDomainPassword” on page 99.
UpdateGatewayInfo Updates the gateway node connectivity information. For more information, see
“UpdateGatewayInfo” on page 100.
UpdateGrid Updates the list of nodes assigned to a grid. For more information, see “UpdateGrid”
on page 101.
UpdateIntegrationService Updates the configuration properties for the Integration Service. For more
information, see “UpdateIntegrationService” on page 102.
UpdateLicense Updates license information for a domain. For more information, see
“UpdateLicense” on page 104.
UpdateNodeOptions Updates gateway node information for a domain. For more information, see
“UpdateNodeOptions” on page 105.
UpdateRepositoryService Updates the service options for the Repository Service. For more information, see
“UpdateRepositoryService” on page 107.
UpdateServiceProcess Updates the service process. For more information, see “UpdateServiceProcess” on
page 109.
UpdateWSHubService Updates the service options for the Web Services Hub Service. For more information,
see “UpdateWSHubService” on page 111.
Required/
Option Argument Description
Optional
-username name_of_user Required User name used to connect to the local domain.
-un
-password password Required Password for the local domain user name. The
-pd password is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
AddDomainLink 25
Table 3-2. AddDomainLink Options and Arguments
Required/
Option Argument Description
Optional
-linkeddomainname name_of_linked Required Name of the domain that you want to establish a
-ld _domain connection with.
-domainlink gateway_host1:port Required The host names and port numbers for the gateway
-dl gateway_host2:port nodes in the linked domain.
...
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodename node_name Required Name of the node you want to add to the domain.
-nn
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodename node_name Required Name of the node where you want to add a resource.
-nn
Required/
Option Argument Description
Optional
-resourcename resource_name Required Name of the resource. To enter a name that contains
-rn 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:
\/*?<>"|$
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
AssignLicense 33
Table 3-7. AssignLicense Options and Arguments
Required/
Option Argument Description
Optional
-licensename name_of_license Required Name of the license you want to assign to a service.
-ln
-servicenames name_of_service1 Required Names of the services for which you want to assign a
-sn name_of_service2 license. To enter a name that contains a space or other
... non-alphanumeric character, enclose the name in
quotation marks.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The
-pd password is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the
-hp gateway_host2:port 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.
AssignRSToWSHubService 35
Table 3-8. AssignRSToWSHubService Options and Arguments
Required/
Option Argument Description
Optional
-servicename name_of_service Required Name of the Web Services Hub Service with
-sn which you want to associate a repository.
-nodename node_name Required Name of the node where you want the Web
-nn Services Hub Service process to run. If the
PowerCenter environment is configured for
high availability, this option specifies the
name of the primary node.
Required/
Option Argument Description
Optional
-inputlocation input_file_location Required Name and path for the log file you want to convert.
-in By default, the Service Manager writes log files to the
server\infa_shared\log directory on the master gateway
node.
-location output_file_location Optional Name and file path for the output file.
-lo If you do not specify an output file location, infacmd displays
the log events on the screen.
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 ...>
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodelist node1 node2 ... Required Names of the nodes you want to assign to the grid.
-nl
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The
-pd password is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the
-hp gateway_host2:port 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.
CreateIntegrationService 39
Table 3-11. CreateIntegrationService Options and Arguments
Required/
Option Argument Description
Optional
-nodename node_name Conditional Name of the node where you want the
-nn 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.
-gridname grid_name Conditional Name of the grid where you want the
-gn Integration Service process to run.
Required if you do not specify the node
name.
Required/
Option Argument Description
Optional
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:
Required/
Option Description
Optional
DataMovementMode Optional 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.
$PMFailureEmailUser Optional Email address of the user to receive email when a session fails
to complete.
CreateIntegrationService 41
Table 3-12. Integration Service Options
Required/
Option Description
Optional
$PMSuccessEmailUser Optional Email address of the user to receive email when a session
completes successfully.
$PMSessionLogCount Optional Number of session logs the Integration Service archives for the
session. Minimum value is 0. Default is 0.
$PMWorkflowLogCount Optional Number of workflow logs the Integration Service archives for the
workflow. Minimum value is 0. Default is 0.
$PMSessionErrorThreshold Optional 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).
TreatCharAsCharOnRead Optional Keeps trailing spaces when reading SAP or PeopleSoft CHAR
data. Default is Yes.
DeadlockSleep Optional 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).
Required/
Option Description
Optional
XMLWarnDupRows Optional Writes duplicate row warnings and duplicate rows for XML
targets to the session log. Default is Yes.
CreateIndicatorFiles Optional Creates indicator files when you run a workflow with a flat file
target. Default is No.
OutputMetaDataForFF Optional Writes column headers to flat file targets. Default is No.
TreatDBPartitionAsPassThrough Optional Uses pass-through partitioning for non-DB2 targets when the
partition type is Database Partitioning. Default is No.
ExportSessionLogLibName Optional Name of an external library file to write session log messages.
TreatNullInComparisonOperators Optional Determines how the Integration Service evaluates null values in
As comparison operations:
- Null
- Low
- High
Default is Null.
If you do not enter a value for this option, infacmd uses the
default value.
MSExchangeProfile Optional Microsoft Exchange profile used by the Service Start Account to
send post-session email.
DateDisplayFormat Optional Date format the Integration Service uses in log entries. Default
is DY MON DD HH 24:MI:SS YYYY.
LoadManagerAllowDebugging Optional Allows you to use this Integration Service to run debugger
sessions from the Designer. Default is Yes.
ErrorSeverityLevel Optional 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.
LogsInUTF8 Optional Writes all logs using the UTF-8 character set. Default is Yes
(Unicode) or No (ASCII).
CreateIntegrationService 43
Table 3-12. Integration Service Options
Required/
Option Description
Optional
TrustStore Optional 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
HttpProxyUser Optional Authenticated user name for the HTTP proxy server. Required if
the proxy server requires authentication.
HttpProxyPassword Optional Password for the authenticated user. Required if the proxy
server requires authentication.
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:
Required/
Option Description
Optional
Codepage_ID Required Code page ID number for the Integration Service process.
For more information about code page ID numbers, see “Code Pages” in
the Administrator Guide.
Required/
Option Description
Optional
$PMCacheDir Optional 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.
JVMMinMemory Optional Minimum amount of memory the Java SDK uses during a PowerCenter
session. Default is 32 MB.
JVMMaxMemory Optional Maximum amount of memory the Java SDK uses during a PowerCenter
session. Default is 64 MB.
CreateIntegrationService 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]
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where you want the Repository
-nn Service process to run. If the PowerCenter environment
is configured for high availability, this option specifies
the name of the primary node.
-backupnodes node1 node2 ... Optional If the PowerCenter environment is configured for high
-bn availability, this option specifies the names of the
backup nodes.
-serviceoptions option_name=value Required Service properties that define how the Repository
-so Service runs. For more information about Repository
Service options, see “Repository Service Options” on
page 47.
-licensename name_of_license Optional Name of the license you want to assign to the
-ln Repository Service.
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:
Required/
Option Description
Optional
CodePage Required 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.
CreateRepositoryService 47
Table 3-15. Repository Service Options
Required/
Option Description
Optional
SecurityAuditTrail Optional 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.
TrustedConnection Optional Uses Windows authentication to access the Microsoft SQL Server
database.
CheckinCommentsRequired Optional Requires users to add comments when checking in repository objects.
ErrorSeverityLevel Optional 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.
MaxResilienceTimeout Optional Maximum amount of time, in seconds, that the service holds on to
resources for resilience purposes. Default is 180.
ServiceResilienceTimeout Optional Amount of time, in seconds, that the service tries to establish or
reestablish a connection to another service. Default is 180.
DatabaseConnectionTimeout Optional Amount of time, in seconds, that the Repository Service attempts to
establish a connection to the database management system. Default
is 180.
HeartBeatInterval Optional Interval at which the Repository Service verifies its connections with
clients of the service. Default is 60 seconds.
DatabaseArrayOperationSize Optional Number of rows to fetch each time an array database operation is
issued, such as insert or fetch. Default is 100.
Required/
Option Description
Optional
MaximumLocks Optional Maximum number of locks the repository places on metadata objects.
Default is 50,000.
DatabasePoolSize Optional Maximum number of connections to the repository database that the
Repository Service can establish. Minimum is 20. Default is 500.
EnableRepAgentCaching Optional Enables the repository agent caching feature. Default is Yes.
RACacheCapacity Optional Number of objects that the cache can contain when repository agent
caching is enabled. Default is 10,000.
AllowWritesWithRACaching Optional Uses PowerCenter Client tools to modify metadata in the repository
when repagent caching is enabled. Default is Yes.
DBPoolExpiryTimeout Optional 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).
DBPoolExpiryThreshold Optional 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.
CreateRepositoryService 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]
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-servicename name_of_service Required Name of the Web Services Hub Service you want to
-sn 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:
/*?<>"|
-nodename node_name Required Name of the node where you want to run the Web
-nn Services Hub Service process.
-repositoryservice repository_service_ Required Name of the Repository Service that the Web
-rs name Services Hub Service depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
-serviceoptions option_name=value Optional Service properties that define how the Web Services
-so ... Hub Service runs. For more information about Web
Services Hub Service options, see “Web Services
Hub Service Options” on page 51.
-licensename name_of_license Optional Name of the license you want to assign to the Web
-ln Services Hub Service.
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:
Required/
Option Description
Optional
WSH_ENCODING Optional Character encoding for the Web Services Hub. Default is UTF-8.
InternalHostName Optional Host name at which the Web Services Hub Service listens for
connections from the Integration Service. Default is localhost.
InternalPortNumber Optional Port number at which the Web Services Hub Service listens for
connections from the Integration Service. Default is 15555.
URLScheme Optional Security protocol that you configure for the Web Services Hub: HTTP
or HTTPS. Default is HTTP.
HubHostName Optional Name of the machine hosting the Web Services Hub. Default is
localhost.
HubPortNumber Optional Port number on which the Web Services Hub runs in Tomcat. Default
is 7333.
ErrorSeverityLevel Optional 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the resource is defined.
-nn
-resourcename resource_name Required Entire name of the resource. To enter a name that
-rn 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-servicename name_of_service Required Name of the service you want to disable. To enter a
-sn name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service associated with the process you
-sn want to disable. To enter a name that contains a space
or other non-alphanumeric character, enclose the name
in quotation marks.
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the service process is running.
-nn
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the resource is defined.
-nn
-resourcename resource_name Required Entire name of the resource. To enter a name that
-rn 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service you want to enable. To enter a
-sn name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service associated with the process you
-sn want to enable. To enter a name that contains a space
or other non-alphanumeric character, enclose the name
in quotation marks.
-nodename node_name Required Name of the node where you want to enable a service
-nn process.
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]
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Optional Name of the service for which you want to fetch error
-sn messages. To enter a name that contains a space or
other non-alphanumeric character, enclose the name
in quotation marks.
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the service runs.
-nn
-format format Optional Format for error messages. Valid types include:
-fm - Text
- XML
If you do not specify a format, infacmd displays the
messages in text format with lines wrapped at 80
characters.
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]
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-startdate start_date_time Optional Returns log events starting from this date and time.
-sd 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”).
-enddate end_date_time Optional Returns log events ending by this date and time. Enter
-ed 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.
-format format Optional Format for log events. Valid types include:
-fm - 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.
-location output_file_location Conditional Name and file path where you want to write the log file.
-lo 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.
GetLog 65
Table 3-25. GetLog Options and Arguments
Required/
Option Argument Description
Optional
-servicetype service_type Optional Type of service for which you want to fetch log events.
-st 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)
-servicename name_of_service Optional Name of the service for which you want to fetch log
-sn events. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway nodes
-hp gateway_host2:port 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.
GetServiceOption 67
Table 3-26. GetServiceOption Options and Arguments
Required/
Option Argument Description
Optional
-servicename name_of_service Required Name of the service for which you want to fetch a value.
-sn To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-optionname option_name Required Name of the option for which you want to retrieve a
-op 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service for which you want to fetch a value.
-sn To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-nodename node_name Required Name of the node where the service process is running.
-nn
-optionname option_name Required Name of the option for which you want to retrieve a
-op value. For more information, see “Service Process
Options” on page 44.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service running the process for which you
-sn want the status. To enter a name that contains a space
or other non-alphanumeric character, enclose the name
in quotation marks.
-nodename node_name Required Name of the node where the service process is running.
-nn
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the service for which you want the status. To
-sn enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
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.
Required/
Option Argument Description
Optional
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-format format Optional Format for the session log. Valid types include:
-fm - 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.
Required/
Option Argument Description
Optional
-location output_file_location Conditional Name and file path for the session log file. By default,
-lo 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.
-integrationservice integration_service_ Required Name of the Integration Service that runs the
-is name session.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
-repositoryservice repository_service_ Required Name of the Repository Service that contains the
-rs name session.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
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.
Required/
Option Argument Description
Optional
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-format format Optional Format for the session log. Valid types include:
-fm - 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.
Required/
Option Argument Description
Optional
-location output_file_location Conditional Name and file path for the workflow log file. By
-lo 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.
-integrationservice integration_service_ Required Name of the Integration Service that runs the
-is name workflow.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
-repositoryservice repository_service_ Required Name of the Repository Service that contains the
-rs name workflow.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
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
Required/
Option Argument Description
Optional
n/a command Optional Name of command. If you omit the command name,
infacmd lists all commands.
Required/
Option Argument Description
Optional
-username name_of_user Required User name used to connect to the local domain.
-un
-password password Required Password for the local domain user name.
-pd
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodename node_name Required Name of the node for which you want to list the
-nn resources.
Required/
Option Argument Description
Optional
-servicename name_of_service Optional Name of the service you want to ping. To enter a name
-sn that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
-gatewayaddress domain_gateway_host Conditional Gateway host machine name and port number.
-dg :port Required if you do not specify the domain name.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-beforedate before_date Required Purges log events that occurred before this date and
-bd time. Enter date and time in one of the following
formats:
- MM/dd/yyyy
- yyyy-MM-dd
Required/
Option Argument Description
Optional
-username name_of_user Required User name used to connect to the local domain.
-un
-password password Required Password for the local domain user name.
-pd
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-linkeddomainname name_of_linked Required Name of the domain from which you want to remove
-ld _domain a connection.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node that has the resource you want to
-nn remove.
-resourcetype resource_type Required Type of resource you want to remove. Valid types
-rt 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.
-resourcename resource_name Required Entire name of the resource you want to remove. To
-rn 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of service you want to remove. To enter a name
-sn that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodename node_name Required Name of the node you want to shut down.
-nn
Required/
Option Arguments Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
UnassignLicense 93
Table 3-47. UnassignLicense Options and Arguments
Required/
Option Arguments Description
Optional
-servicenames name_of_service1 Required Names of the services for which you want to remove the
-sn name_of_service2 license. To enter a name that contains a space or other
... non-alphanumeric character, enclose the name in
quotation marks.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The
-pd password is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the Web Services Hub Service from
-sn which you want to disassociate a repository.
UnassignRSWSHubService 95
Table 3-48. UnassignRSWSHubService Options and Arguments
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the Web Services
-nn Hub Service process runs. If the
PowerCenter environment is configured for
high availability, this option specifies the
name of the primary node.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node you want to disassociate from the
-nn domain.
Required/
Option Argument Description
Optional
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
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
Required/
Option Argument Description
Optional
-gatewayaddress domain_gateway_host: Required Gateway host machine name and port number.
-dg port
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-nodelist node1 node2 ... Required Names of the nodes you want to assign to the grid.
-nl This list of nodes replaces the list of nodes previously
assigned to the grid.
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 ...]
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
Required/
Option Argument Description
Optional
-nodename node_name Optional Name of the node where the Integration Service
-nn 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.
-gridname grid_name Optional Name of the grid where the Integration Service
-gn process runs.
Do not enter a value for this option if you specify the
node name.
-backupnodes node1 node2 ... Optional If the PowerCenter environment is configured for high
-bn availability, this option specifies the names of the
backup nodes.
Do not enter values for this option if you specify the
grid name.
-repositoryservice repository_service_ Optional Name of the Repository Service that the Integration
-rs name Service depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-serviceoptions option_name=value Optional Service properties that define how the Integration
-so Service runs. For more information about Integration
Service options, see “Integration Service Options” on
page 41.
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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-licensename name_of_license Required Name of the license object you want to update.
-ln
-licensekeyfile license_key_file Required Name and path to the file that contains the incremental
-lf keys.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
UpdateNodeOptions 105
Table 3-55. UpdateNodeOptions Options and Arguments
Required/
Option Argument Description
Optional
-nodename node_name Optional Name of the node whose resource provision thresholds
-nn you want to update.
-resourceprovision MaxProcesses=value Required The resource provision thresholds you want to update.
-rp 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
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password is
-pd case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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
Required/
Option Argument Description
Optional
-servicename name_of_service Required Name of the Repository Service you want to update. To
-sn enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-nodename node_name Optional Name of the node where the Repository Service
-nn process runs. If the PowerCenter environment is
configured for high availability, this option specifies the
name of the primary node.
-backupnodes node1 node2 ... Optional If the PowerCenter environment is configured for high
-bn availability, this option specifies the names of the
backup nodes.
-serviceoptions option_name=value Required Service properties that define how the Repository
-so Service runs. For more information about Repository
Service options, see “Repository Service Options” on
page 47.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The
-pd password is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
UpdateServiceProcess 109
Table 3-57. UpdateServiceProcess Options and Arguments
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where you want to update
-nn configuration information.
-serviceprocessoptions option_name=value Required Name and new values of the options whose values
-pc 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.
Required/
Option Argument Description
Optional
-password password Required Password for the domain user name. The password
-pd is case-sensitive.
-gateway gateway_host1:port Conditional The host names and port numbers for the gateway
-hp gateway_host2:port 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.
-servicename name_of_service Required Name of the Web Services Hub Service you want to
-sn update.
UpdateWSHubService 111
Table 3-58. UpdateWSHubService Options and Arguments
Required/
Option Argument Description
Optional
-nodename node_name Required Name of the node where the Web Services Hub
-nn Service process runs.
-repositoryservice repository_service_ Required Name of the Repository Service that the Web
-rs name Services Hub Service depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in
quotation marks.
-serviceoptions option_name=value Required Service properties that define how the Web Services
-so ... Hub Service runs. For more information about Web
Services Hub Service options, see “Web Services
Hub Service Options” on page 51.
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.
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 case-
sensitive.
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.
Command Description
BackupDomain Backs up the configuration metadata for the domain. For more information, see
“BackupDomain” on page 117.
DefineDomain Defines a domain on the current machine. For more information, see “DefineDomain” on
page 119.
DefineGatewayNode Defines a gateway node on the current machine. For more information, see
“DefineGatewayNode” on page 122.
DefineWorkerNode Defines a worker node on the current machine. For more information, see “DefineWorkerNode”
on page 124.
Help Returns the syntax for the command you specify. Lists the options for the command. For more
information, see “Help” on page 126.
RestoreDomain Restores the configuration metadata for the domain. For more information, see
“RestoreDomain” on page 127.
UpdateGatewayNode Updates connectivity information for a gateway node. For more information, see
“UpdateGatewayNode” on page 129.
UpdateWorkerNode Updates connectivity information for a worker node. For more information, see
“UpdateWorkerNode” on page 131.
Required/
Option Argument Description
Optional
-databaseaddress database_hostname: Required Name and port number of the machine hosting the
-da database_port domain configuration database.
-databaseusername database_username Required Account for the database containing the domain
-du configuration information.
-databaseservicename database_service_ Conditional The database service name. Required for Oracle
-ds name and DB2 databases. Enter the SID for Oracle or the
service name for DB2.
-backupfile back_file_location Required Name and file path for the backup file. If you do not
-bf specify a file path, infasetup creates the backup file
in the current directory.
BackupDomain 117
Table 4-2. BackupDomain Options and Arguments
Required/
Option Argument Description
Optional
-force n/a Optional Overwrites the backup file if a file with the same
-f name already exists.
Required/
Option Argument Description
Optional
DefineDomain 119
Table 4-3. DefineDomain Options and Arguments
Required/
Option Argument Description
Optional
-logservicedirectory logservice_directory Optional Shared directory path used by the Log Manager to
-ld store log event files.
For more information about the Log Manager, see
“Managing Logs” in the Administrator Guide.
-nodeaddress nodehost:port Required Host name and port number for the machine hosting
-na the node. Choose an available port number.
-serverport server_admin_port_ Optional TCP/IP port number used by the Service Manager.
-sv number 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.
-errorloglevel fatal Optional Severity level for log events in the domain log.
-el error Default is info.
warning
info
trace
debug
-resourcefile resource_file Required File that contains the list of available resources for
-rf the node. Use the file, nodeoptions.xml, located in
the server\tomcat\bin directory.
-databaseaddress database_hostname: Required Name and port number of the machine hosting the
-da database_port domain configuration database.
-databaseusername database_username Required Account for the database containing the domain
-du configuration information.
Required/
Option Argument Description
Optional
-databaseservicename database_service_ Conditional The database service name. Required for Oracle
-ds name and DB2 databases. Enter the SID for Oracle or the
service name for DB2.
-timezone logservice_timezone Optional Time zone used by the Log Manager when it
-tz generates log event files. Configure the time zone in
the following format:
GMT(+/-)hh:mm
For more information about the Log Manager, see
“Managing Logs” in the Administrator Guide.
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
Required/
Option Argument Description
Optional
-databaseaddress database_hostname: Required Name and port number of the machine hosting
-da database_port the domain configuration database.
-databaseusername database_username Required Account for the database containing the domain
-du configuration information.
Required/
Option Argument Description
Optional
-domainname name_of_domain Required Name of the domain the gateway node links to.
-dn
-nodeaddress nodehost:port Required Host name and port number for the machine
-na hosting the node. Choose an available port
number.
-logservicedirectory logservice_directory Required Shared directory path used by the Log Manager
-ld to store log event files.
For more information about the Log Manager,
see “Managing Logs” in the Administrator
Guide.
-errorloglevel fatal Optional Severity level for log events in the domain log.
-el error Default is info.
warning
info
trace
debug
-resourcefile resource_file Required File that contains the list of available resources
-rf for the node. Use the file, nodeoptions.xml,
located in the server\tomcat\bin directory.
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
Required/
Option Argument Description
Optional
-domainname name_of_domain Required Name of the domain the worker node links to.
-dn
-nodeaddress nodehost:port Required Host name and port number for the machine
-na hosting the node. Choose an available port
number.
-gatewayaddress domain_gateway_ Required Gateway host machine name and port number.
-dg host:port
Required/
Option Argument Description
Optional
-errorloglevel fatal Optional Severity level for log events in the domain log.
-el error Default is info.
warning
info
trace
debug
-serverport server_admin_port_ Optional TCP/IP port number used by the Service Manager.
-sv number 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.
-resourcefile resource_file Required File that contains the list of available resources for
-rf the node. Use the file, nodeoptions.xml, located in
the server\tomcat\bin directory.
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]
Required/
Option Argument Description
Optional
n/a command Optional Name of command. If you omit the command name,
infasetup lists all commands.
Required/
Option Argument Description
Optional
-databaseaddress database_hostname: Required Name and port number of the machine where you
-da database_port want to restore the domain configuration database.
-databaseusername database_username Required Account for the database containing the domain
-du configuration information.
-databaseservicename database_service_ Conditional The database service name. Required for Oracle
-ds name and DB2 databases. Enter the SID for Oracle or the
service name for DB2.
-backupfile back_file_location Required Name and file path for the backup file. If you do not
-bf specify a file path, infacmd looks for the backup file
in the directory where you run infacmd.
RestoreDomain 127
Table 4-7. RestoreDomain Options and Arguments
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-databaseaddress database_hostname: Optional Name and port number of the machine hosting
-da database_port the domain configuration database.
-databaseusername database_username Optional Account for the database containing the domain
-du configuration information.
UpdateGatewayNode 129
Table 4-8. UpdateGatewayNode Options and Arguments
Required/
Option Argument Description
Optional
-nodeaddress nodehost:port Optional Host name and port number for the machine
-na hosting the node. Choose an available port
number.
-logservicedirectory logservice_directory Optional Shared directory path used by the Log Manager
-ld to store log event files.
For more information about the Log Manager,
see “Managing Logs” in the Administrator
Guide.
Required/
Option Argument Description
Optional
-nodeaddress nodehost:port Optional Host name and port number for the machine
-na hosting the node. Choose an available port
number.
-gatewayaddress domain_gateway_ Optional Gateway host machine name and port number.
-dg host:port
-serverport server_admin_port_ Optional TCP/IP port number used by the Service Manager.
-sv number 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.
UpdateWorkerNode 131
132 Chapter 4: infasetup Commands Reference
Chapter 5
pmcmd Commands
Reference
This chapter includes the following topics:
♦ 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.
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.
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.
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:
♦ In a DOS shell: echo %ERRORLEVEL%
♦ In a UNIX Bourne or Korn shell: echo $?
♦ In a UNIX C shell: echo $status
Table 5-1 describes the return codes for pmcmd:
Code Description
0 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.
1 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.
8 You do not have the appropriate permissions or privileges to perform this task.
9 Connection to the Integration Service timed out while sending the request.
12 Integration Service cannot start recovery because the session or workflow is scheduled, waiting for an
event, waiting, initializing, aborting, stopping, disabled, or running.
Code Description
18 Integration Service found the parameter file, but it did not have the initial values for the session parameters,
such as $input or $output.
19 Integration Service cannot resume the session because the workflow is configured to run continuously.
20 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.
22 Integration Service cannot find a unique instance of the workflow/session you specified. Enter the command
again with the folder name and workflow name.
24 Out of memory.
25 Command is cancelled.
For a list of commands available in interactive mode, see “pmcmd Commands” on page 140.
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
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:
Command Description
setfolder Designates a folder as the default folder in which to execute all subsequent commands.
setnowait 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.
setwait Executes subsequent commands in the wait mode. The pmcmd prompt is available after the
Integration Service completes the previous command.
You can use the showsettings command to display the default settings. For more information
about the showsettings command, see “showsettings” on page 170.
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
if [ "$?" != 0 ]; then
# handle error
echo "Could not ping service"
exit
fi
if [ "$?" != 0 ]; then
# handle error
echo "Could not get service properties"
exit
fi
if [ "$?" != 0 ]; then
# handle error
echo "Could not get details for task s_testSessionTask"
exit
fi
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 ("").
aborttask Command line, Aborts a task. Issue this command only if the Integration Service fails
Interactive to stop when you issue the stoptask command. For more information,
see “aborttask” on page 143.
abortworkflow Command line, Aborts a workflow. Issue this command only if the Integration Service
Interactive fails to stop the workflow when you issue the stopworkflow command.
For more information, see “abortworkflow” on page 145.
connect Interactive 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.
disconnect Interactive Disconnects from the Integration Service in the interactive mode. For
more information, see “disconnect” on page 148.
exit Interactive Exits from pmcmd in the interactive mode. For more information, see
“exit” on page 149.
getrunningsessionsdetails Command line, Displays details for sessions currently running on an Integration
Interactive 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.
getservicedetails Command line, Displays details for the Integration Service including service status,
Interactive 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.
getserviceproperties Command line, Displays the Integration Service name, type, and version. It returns
Interactive 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.
getsessionstatistics Command line, Displays session details including information for the folder, workflow,
Interactive 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.
gettaskdetails Command line, Displays details for a task including folder and workflow name. Also
Interactive 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.
getworkflowdetails Command line, Displays details for a workflow including workflow name, status, and
Interactive run mode. Also displays information about the last workflow run. For
more information, see “getworkflowdetails” on page 159.
help Command line, Displays a list of pmcmd commands and syntax. For more information,
Interactive see “help” on page 161.
pingservice Command line, Determines whether the Integration Service is running. For more
Interactive information, see “pingservice” on page 162.
recoverworkflow Command line, Recovers a suspended workflow. For more information, see
Interactive “recoverworkflow” on page 163.
scheduleworkflow Command line, Instructs the Integration Service to schedule a workflow. Use this
Interactive command to manually reschedule a workflow that has been removed
from the schedule. For more information, see “scheduleworkflow” on
page 165.
showsettings Interactive 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.
startask Command line, Starts a task. For more information, see “starttask” on page 171.
Interactive
startworkflow Command line, Starts a workflow. For more information, see “startworkflow” on
Interactive page 174.
stoptask Command line, Stops a task. For more information, see “stoptask” on page 177.
Interactive
stopworkflow Command line, Stops a workflow. For more information, see “stopworkflow” on
Interactive page 179.
unscheduleworkflow Command line, Removes a workflow from the schedule. For more information, see
Interactive “unscheduleworkflow” on page 181.
unsetfolder Interactive Designates no folder as the default folder. For more information, see
“unsetfolder” on page 183.
version Command line, Displays the PowerCenter version number. For more information, see
Interactive “version” on page 184.
waittask Command line, Instructs the Integration Service to wait for the completion of a running
Interactive task before starting another command. For more information, see
“waittask” on page 185.
waitworkflow Command line, Notifies you whether the workflow ran successfully or is not running.
Interactive For more information, see “waitworkflow” on page 187.
The aborttask command uses the following syntax in the interactive mode:
aborttask
[<-folder|-f> folder]
<-workflow|-w> workflow
[-wait|-nowait]
taskInstancePath
Required/
Option Argument Description
Optional
aborttask 143
Table 5-4. aborttask Options and Arguments
Required/
Option Argument Description
Optional
n/a taskInstancePath Required 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.
The abortworkflow command uses the following syntax in the interactive mode:
abortworkflow
[<-folder|-f> folder]
[-wait|-nowait]
workflow
Required/
Option Argument Description
Optional
abortworkflow 145
Table 5-5. abortworkflow Options and Arguments
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
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
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:
getrunningsessionsdetails
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
getrunningsessionsdetails 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]
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
getservicedetails 153
getserviceproperties
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:
getserviceproperties
Required/
Option Argument Description
Optional
The getsessionstatistics command uses the following syntax in the interactive mode:
getsessionstatistics
[<-folder|-f> folder]
<-workflow|-w> workflow
taskInstancePath
Required/
Option Argument Description
Optional
getsessionstatistics 155
Table 5-10. getsessionstatistics Options and Arguments
Required/
Option Argument Description
Optional
n/a taskInstancePath Required 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.
The gettaskdetails command uses the following syntax in the interactive mode:
gettaskdetails
[<-folder|-f> folder]
<-workflow|-w> workflow
taskInstancePath
Required/
Option Argument Description
Optional
gettaskdetails 157
Table 5-11. gettaskdetails Options and Arguments
Required/
Option Argument Description
Optional
n/a taskInstancePath Required 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.
The getworkflowdetails command uses the following syntax in the interactive mode:
getworkflowdetails
[<-folder|-f> folder]
workflow
Required
Option Argument Description
Optional
getworkflowdetails 159
Table 5-12. getworkflowdetails Options and Arguments
Required
Option Argument Description
Optional
The help command uses the following syntax in the interactive mode:
help [command]
Required/
Option Argument Description
Optional
n/a command Optional 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
Required/
Option Argument Description
Optional
The recoverworkflow command uses the following syntax in the interactive mode:
recoverworkflow
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[-wait|-nowait]
workflow
Required/
Option Argument Description
Optional
recoverworkflow 163
Table 5-15. recoverworkflow Options and Arguments
Required/
Option Argument Description
Optional
-paramfile paramfile Optional Determines which parameter file to use when a task or
workflow runs. It overrides the configured parameter file for
the workflow or task.
-localparamfile localparamfile Optional Specifies the parameter file on a local machine that pmcmd
-lpf uses when you start a workflow.
The scheduleworkflow command uses the following syntax in the interactive mode:
scheduleworkflow
[<-folder|-f> folder]
workflow
Required/
Option Argument Description
Optional
scheduleworkflow 165
Table 5-16. scheduleworkflow Options and Arguments
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
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.
Note: Use this command in the pmcmd interactive mode only.
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
The starttask command uses the following syntax in the interactive mode:
starttask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-paramfile> paramfile]
[-wait|-nowait]
[<-recovery>]
taskInstancePath
Required/
Option Argument Description
Optional
starttask 171
Table 5-18. starttask Options and Arguments
Required/
Option Argument Description
Optional
-paramfile paramfile Optional Determines which parameter file to use when a task or
workflow runs. It overrides the configured parameter file for
the workflow or task.
-recovery n/a Optional If the task is a session, runs the session based on the
configured recovery strategy.
n/a taskInstancePath Required 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.
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"
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
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-paramfile paramfile Optional Determines which parameter file to use when a task or
workflow runs. It overrides the configured parameter file for
the workflow or task.
-localparamfile localparamfile Optional Specifies the parameter file on a local machine that pmcmd
-lpf uses when you start a workflow.
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'
♦ 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'
♦ 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'
The stoptask command uses the following syntax in the interactive mode:
stoptask
[<-folder|-f> folder]
<-workflow|-w> workflow
[-wait|-nowait]
taskInstancePath
Required/
Option Argument Description
Optional
stoptask 177
Table 5-20. stoptask Options and Arguments
Required/
Option Argument Description
Optional
n/a taskInstancePath Required 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.
The stopworkflow command uses the following syntax in the interactive mode:
stopworkflow
[<-folder|-f> folder]
[-wait|-nowait]
workflow
Required/
Option Argument Description
Optional
stopworkflow 179
Table 5-21. stopworkflow Options and Arguments
Required/
Option Argument Description
Optional
The unscheduleworkflow command uses the following syntax in the interactive mode:
unscheduleworkflow
[<-folder|-f> folder]
workflow
Required/
Option Argument Description
Optional
unscheduleworkflow 181
Table 5-22. unscheduleworkflow Options and Arguments
Required/
Option Argument Description
Optional
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
The waittask command uses the following syntax in the interactive mode:
waittask
[<-folder|-f> folder]
<-workflow|-w> workflow
taskInstancePath
Required/
Option Argument Description
Optional
waittask 185
Table 5-23. waittask Options and Arguments
Required/
Option Argument Description
Optional
n/a taskInstancePath Required 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.
The waitworkflow command uses the following syntax in the interactive mode:
waitworkflow
[<-folder|-f> folder]
workflow
Required/
Option Argument Description
Optional
waitworkflow 187
Table 5-24. waitworkflow Options and Arguments
Required/
Option Argument Description
Optional
pmrep Commands
Reference
This chapter includes the following topics:
♦ 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.
1. At the command prompt, change to the directory where the pmrep executable is located.
2. Enter pmrep followed by the command name and its options and arguments:
pmrep command_name [-option1] argument_1 [-option2] argument_2...
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
REM This batch file uses pmrep to connect to and back up the repository
Production on the server ServerName
@echo off
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
Command Description
AddPrivilege Adds a privilege to a user or group. For more information, see “AddPrivilege” on
page 198.
AddUserToGroup Adds a user to a group. For more information, see “AddUserToGroup” on page 201.
ApplyLabel Applies a label to an object or set of objects in a folder. For more information, see
“ApplyLabel” on page 202.
BackUp Backs up a repository. For more information, see “BackUp” on page 204.
ChangePasswd Changes the password for the user currently connected to the repository. For more
information, see “ChangePasswd” on page 205.
CheckIn Checks in an object. For more information, see “CheckIn” on page 206.
CleanUp Cleans up persistent resources created by pmrep during a session. For more
information, see “CleanUp” on page 207.
ClearDeploymentGroup Clears all objects from a deployment group. For more information, see
“ClearDeploymentGroup” on page 208.
Connect Connects to the repository. For more information, see “Connect” on page 209.
Create Creates repository tables in the database. For more information, see “Create” on
page 211.
CreateFolder Creates a folder. For more information, see “CreateFolder” on page 218.
CreateGroup Creates a group. For more information, see “CreateGroup” on page 220.
CreateLabel Creates a label object. For more information, see “CreateLabel” on page 221.
CreateUser Creates a user. For more information, see “CreateUser” on page 222.
Delete Deletes the repository tables from the database. For more information, see “Delete” on
page 223.
Command Description
DeleteFolder Deletes a folder. For more information, see “DeleteFolder” on page 226.
DeleteLabel Deletes a label object and all object references to the label. For more information, see
“DeleteLabel” on page 227.
DeployFolder Deploys a folder. For more information, see “DeployFolder” on page 230.
EditUser Edits the profile of a user. For more information, see “EditUser” on page 232.
ExecuteQuery Executes a query. For more information, see “ExecuteQuery” on page 234.
Exit Exits from pmrep. For more information, see “Exit” on page 236.
FindCheckout Prints a list of checked out objects in the repository. For more information, see
“FindCheckout” on page 237.
Help Displays help for all commands or for a specified command. For more information, see
“Help” on page 239.
KillUserConnection Terminates user connection to the repository. For more information, see
“KillUserConnection” on page 240.
ListAllGroups Lists all groups registered with the repository. For more information, see “ListAllGroups”
on page 241.
ListAllPrivileges Lists all privileges that you can assign to a user or group. For more information, see
“ListAllPrivileges” on page 242.
ListAllUsers Lists all users registered with the repository. For more information, see “ListAllUsers”
on page 243.
ListGroupsForUser Lists all groups that the user belongs to. For more information, see
“ListGroupsForUser” on page 244.
ListObjects Lists objects in the repository. For more information, see “ListObjects” on page 248.
ListTablesBySess Lists sources or targets in a session. For more information, see “ListTablesBySess” on
page 254.
ListUserConnections Lists user connections to the Repository Service. For more information, see
“ListUserConnections” on page 256.
LsPrivileges Lists the privileges granted to a user or group. For more information, see “LsPrivileges”
on page 257.
ModifyFolder Modifies folder properties. For more information, see “ModifyFolder” on page 258.
Notify Sends notification messages. For more information, see “Notify” on page 259.
ObjectExport Exports objects to an XML file. For more information, see “ObjectExport” on page 260.
ObjectImport Imports objects from an XML file. For more information, see “ObjectImport” on
page 262.
Command Description
Register Registers local repositories with global repositories. For more information, see
“Register” on page 263.
RegisterPlugin Registers a new external module to the repository. For more information, see
“RegisterPlugin” on page 265.
RegisterUser Registers a user from an external directory service to access the Repository. For more
information, see “RegisterUser” on page 267.
Restore Restores a repository from a repository backup file. For more information, see
“Restore” on page 268.
RmGroup Removes a group from the repository. For more information, see “RmGroup” on
page 271.
RmPrivilege Removes a privilege from a user or group. For more information, see “RmPrivilege” on
page 272.
RmUser Removes a user from the repository. For more information, see “RmUser” on page 273.
RmUserFromGroup Removes a user from a group. For more information, see “RmUserFromGroup” on
page 274.
Run Displays messages stating whether a run has completed or failed. For more
information, see “Run” on page 275.
ShowConnectionInfo Shows repository name, server, port and user information for the current connection.
For more information, see “ShowConnectionInfo” on page 276.
SwitchConnection Changes the name of an existing connection. For more information, see
“SwitchConnection” on page 277.
TruncateLog Truncates log details from repository level, folder level, or workflow level. For more
information, see “TruncateLog” on page 278.
UndoCheckout Undoes an object check out, releases the lock, and reverts to the last checked in
version. For more information, see “UndoCheckout” on page 279.
Unregister Unregisters local repositories from global repositories. For more information, see
“Unregister” on page 280.
UnregisterPlugin Unregisters a plug-in module from the repository. For more information, see
“UnregisterPlugin” on page 282.
UpdateConnection Changes user name, password, and connect string for a connection. For more
information, see “UpdateConnection” on page 284.
UpdateEmailAddr Updates the session notification email addresses. For more information, see
“UpdateEmailAddr” on page 286.
UpdateSeqGenVals Updates transformation properties for Sequence Generator transformations. For more
information, see “UpdateSeqGenVals” on page 287.
UpdateSrcPrefix Updates source table owner names. For more information, see “UpdateSrcPrefix” on
page 289.
UpdateStatistics Updates statistics for repository tables and indexes. For more information, see
“UpdateStatistics” on page 291.
Command Description
UpdateTargPrefix Updates target table name prefixes. For more information, see “UpdateTargPrefix” on
page 292.
Upgrade Upgrades an existing repository to the latest version. For more information, see
“Upgrade” on page 293.
Validate Validates objects. For more information, see “Validate” on page 294.
Version Displays the PowerCenter version number. For more information, see “Version” on
page 297.
Required/
Option Argument Description
Optional
-p privilege Required 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
-u repository_user_ Conditional Name of the user to whom you want to add the privilege. If you use
name this option, you cannot use the -g option. Required if you do not
use -g.
-g group_name Conditional 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.
Required/
Option Argument Description
Optional
-n object_name Conditional 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
Required/
Option Argument Description
Optional
-o object_type Conditional 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.
-v version_number Optional Version of the object to add. The default is to add the
latest version of the object to the deployment group.
-f folder_name Conditional Folder that contains the object you are adding. Required
when you enter an object name.
Required/
Option Argument Description
Optional
-g group_name Required 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>]
Required/
Option Argument Description
Optional
-n object_name Conditional 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.
Required/
Option Argument Description
Optional
-o object_type Conditional 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.
-v version_number Optional 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.
-f folder_name Optional 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.
-p dependency_direction Optional 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.
-m n/a Optional 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.
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:
Required/
Option Argument Description
Optional
-o output_file_name Required Name and path of the file for the repository backup.
-d description Optional Creates a description of the backup file based on the string that
follows the option. The backup process truncates any character
beyond 2,000.
-b n/a Optional Skips tables related to workflow and session logs during
backup.
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.
Required/
Option Argument Description
Optional
-p new_password Conditional 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.
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>]
Required/
Option Argument Description
Optional
-o object_type Required Type of object you are checking in: source, target,
transformation, mapping, session, worklet, workflow,
scheduler, session config, task, cube, or dimension.
-t object_subtype Optional Type of task or transformation to check in. Not required for
other object types. For valid subtypes, see Table 6-36 on
page 251.
-n object_name Required Name of the object that you are checking in.
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)]
Required/
Option Argument Description
Optional
-p deployment_group_name Required Name of the deployment group that you want to clear.
Required/
Option Argument Description
Optional
-d domain_name Conditional 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.
-h portal_host_name Conditional Gateway host name. Required if you do not use -d. If you use
the -h option, then you must also use the -o option.
Connect 209
Table 6-11. Connect Options and Arguments
Required/
Option Argument Description
Optional
-o portal_port_number Conditional Gateway port number. Required if you do not use -d. If you
use the -o option, then you must also use the -h option.
-x repository_password Conditional 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.
Required/
Option Argument Description
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)]
Required/
Option Argument Description
Optional
-s connection_type Required Type of connection. For a list of valid database types, see
Table 6-14 on page 214.
-u user_name Required User name used for authentication when you connect to the
relational database.
-p password Optional 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.
Required/
Option Argument Description
Optional
-c connect_string Conditional 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.
-l code_page Required Code page associated with the connection. For a list of valid
code page IDs, see Table 6-15 on page 215.
-r rollback_segment Optional Valid for Oracle connections. The name of the rollback
segment. A rollback segment records database transactions
that allow you to undo the transaction.
-e connection_environm Optional Enter SQL commands to set the database environment when
ent_sql you connect to the database. The Integration Service
executes the connection environment SQL each time it
connects to the database.
-f transaction_environm Optional Enter SQL commands to set the database environment when
ent_sql you connect to the database. The Integration Service
executes the transaction environment SQL at the beginning of
each transaction.
-z packet_size Optional Valid for Sybase ASE and Microsoft SQL Server connections.
Optimizes the ODBC connection to Sybase ASE and Microsoft
SQL Server.
-b database_name Optional Name of the database. Valid for Sybase ASE and Microsoft
SQL Server connections.
-v server_name Optional Name of the database server. Valid for Sybase ASE and
Microsoft SQL Server connections.
-d domain_name Optional Valid for Microsoft SQL Server connections. The name of the
domain. Used for Microsoft SQL Server.
-t n/a Optional 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.
-a data_source_name Required Teradata ODBC data source name. Valid for Teradata
connections.
CreateConnection 213
Table 6-13. CreateConnection Options and Arguments
Required/
Option Argument Description
Optional
-x n/a Optional 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.
ODBC ODBC
Oracle Oracle
CreateConnection 215
Table 6-15. Code Page ID by Name
Required/
Option Argument Description
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>]
Required/
Option Argument Description
Optional
-d folder_description Optional Description of the folder that displays in the Repository Manager.
-o owner_name Optional Owner of the folder. Any user in the repository can be the folder
owner. Default owner is the user creating the folder.
-p permissions Optional Access rights for the folder. If omitted, the Repository Service
assigns default permissions.
-f active Optional Change the folder status to one of the following status:
frozendeploy - active. This status allows users to check out versioned objects
frozennodeploy 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.
This gives the folder owner read, write, and execute permissions (7 = 4+2+1). The owner’s
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>]
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
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.
Required/
Option Argument Description
Optional
-u repository_user_name Required User name of the new user. The user name must be 7-bit
ASCII, is case sensitive, and cannot contain spaces.
-p password Conditional 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.
-g group_name Optional Group assigned to the new user. The new user inherits all
permissions and privileges granted to the group.
Required/
Option Argument Description
Optional
-x repository_password_for_ Optional Repository password. You can use the -x or -X option, but
confirmation not both. If you do not use the -x or -X option, pmrep
prompts you to enter the repository password for
confirmation.
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 owner’s group.
The DeleteConnection command uses the following syntax:
deleteconnection
-n <relational_connection_name>
[-f (force delete)]
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
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>
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-f n/a Optional 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>]
Required/
Option Argument Description
Optional
-c control_file_name Required 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.
-r target_repository_name Required Name of the target repository where you are copying
the deployment group.
-n target_repository_user_ Conditional Login user name for the target repository. Required if
name you copy the deployment group to a different
repository.
-x target_repository_password Optional 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.
-h target_portal_host_name Conditional 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.
-o target_portal_port_number Conditional 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.
-l log_file_name Optional Log file that records each deployment step. If you omit
this option, pmrep outputs the deployment steps to the
command line window.
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>]
Required/
Option Argument Description
Optional
-c control_file_name Required 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.
Required/
Option Argument Description
Optional
-r target_repository_name Required Name of the target repository you are copying the
folder to.
-n target_repository_user_name Conditional Login user name for the target repository. Required if
you copy the folder to another repository.
-x target_repository_user_ Optional Login password for the target repository. Use the -x or
password -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.
-d target_domain_name Conditional 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.
-h target_portal_host_name Conditional 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.
-o target_portal_port_number Conditional 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.
-l log_file_name Optional Log file that records each deployment step. If you omit
this option, pmrep outputs the deployment steps to the
command line window.
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> ]
Required/
Option Argument Description
Optional
-u repository_user_name Required Replace the user name of the user currently connected to
the repository.
-c confirm_password Conditional 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.
-l new_login Optional Specifies a new login to map the user name. Use this
option with an external directory service.
Required/
Option Argument Description
Optional
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)]
Required/
Option Argument Description
Optional
-t query_type Optional 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.
-u persistent_output_file_name Optional Send the query result to a text file. If you do not enter
a file name, the query result goes to stdout.
-a n/a Optional Appends the query results to the persistent output file.
If you do not enter this option, pmrep overwrites the
file content.
Required/
Option Argument Description
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
Required/
Option Argument Description
Optional
-o object_type Conditional 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.
-f folder_name Conditional 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.
-u n/a Optional List the checked out objects by all users. The default is
to list checked out objects by the current user.
FindCheckout 237
Table 6-30. FindCheckout Options and Arguments
Required/
Option Argument Description
Optional
-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)}
Required/
Option Argument Description
Optional
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
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>
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-o object_type Required Object type to list dependencies for. You can specify source,
target, transformation, mapping, session, worklet, workflow,
scheduler, session, session config, task, cube, and
dimension.
-t object_subtype Conditional Type of transformation or task. Ignored for other object types.
For valid subtypes, see Table 6-36 on page 251.
-v version_number Optional List dependent objects for an object version other than the
latest version.
ListObjectDependencies 245
Table 6-33. ListObjectDependencies Options and Arguments
Required/
Option Argument Description
Optional
-f folder_name Conditional Folder containing object name. Folder is required if you do not
use the -i option.
-d dependency_object_t Optional Type of dependent objects to list. You can enter ALL or one or
ypes 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.
-p dependency_direction Conditional 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.
-u persistent_output_file Optional Send the dependency result to a text file. Use the text file as
_name input to the ApplyLabel, AddToDeployment Group, or Validate
pmrep commands. The default sends the query result to
stdout.
-a n/a Optional Append the result to the persistent output file name file
instead of overwriting it.
-r end-of- Optional Character or set of characters used to specify the end of the
record_separator object metadata. Use a character or set of characters that is
not used in repository object names.
Default is newline /n.
Required/
Option Argument Description
Optional
-l end-of- Optional Character or set of characters used to specify the end of the
listing_indicator 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.
-b n/a Optional 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.
ListObjectDependencies 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.
Required/
Option Argument Description
Optional
-f folder_name Conditional Folder to search. Use this option for all object types except
deploymentgroup, folder, label, and query. Required if you
list objects other than folders.
-r end-of-record_indicator Optional 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.
-l end_of_listing_indicator Optional 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.
-b n/a Optional 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 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.
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:.
Mapplet List mapplets with latest or checked out version in a folder, including shortcuts
but excluding instances of reusable mapplets.
Mapping List mappings with latest or checked out version in a folder, including shortcuts
but excluding instances of reusable mapplets.
Scheduler List reusable and non-reusable schedulers with latest or checked out version
in a folder.
Session List reusable and non-reusable sessions with latest or checked out version in
a folder, excluding instances of reusable sessions.
Sessionconfig List the session configurations with latest or checked out version in a folder.
Source List sources with latest or checked out version in a folder, including shortcuts
but excluding source instances.
Target List targets with latest or checked out version in a folder, including shortcuts
but excluding target instances.
Task List reusable and non-reusable tasks with latest or checked out version in a
folder.
Transformation List reusable and non-reusable transformations with latest or checked out
version in a folder, including shortcuts and excluding instances of reusable
transformations.
Workflow List the workflows with latest version or checked out version in a folder.
Worklet List reusable and non-reusable worklets with latest version or checked out
version in a folder, excluding instances of reusable worklets.
ListObjects 251
Table 6-36. Transformation and Task Types to Use with pmrep
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
To list all Stored Procedure transformations in a folder, enter the following text at the prompt:
listobjects -o transformation -t stored_procedure -f myfolder
To list all sessions in a folder, enter the following text at the prompt:
listobjects -o session -f myfolder
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)
Required/
Option Argument Description
Optional
-s session_name Required 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.
-t object_type_liste Required Enter source to list sources, or enter target to list targets.
d
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
mapplet1.ORDERS
Shortcut_To_ITEM_ID
ORDERS_BY_CUSTID
Shortcut_To_tgt2_inst
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
Required/
Option Argument Description
Optional
-u user_name Conditional Name of the user to list privileges for. Required if you do not
use the -g option. Use -u or -g, but not both.
-g group_name Conditional Name of the group to list privileges for. Required if you do not
use the -u option. Use -u or -g, but not both.
-o n/a Optional 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)]
Required/
Option Argument Description
Optional
-o owner_name Optional Current owner of the folder. Any user in the repository can
be the folder owner. Default owner is the current user.
-p permissions Optional 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.
-f folder_status Optional 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.
Required/
Option Argument Description
Optional
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>]
Required/
Option Argument Description
Optional
-n object_name Conditional 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.
-o object_type Conditional 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.
Required/
Option Argument Description
Optional
-v version_number Optional Exports the version of the object that you enter.
-f folder_name Conditional 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.
-i persistent_input_file Conditional 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.
-m n/a Optional Exports primary key table definitions when you export sources
or targets with foreign keys.
-b n/a Optional Exports non-reusable objects used by the object. Must specify
-b and -r to export mapping dependencies.
-r n/a Optional Exports reusable objects used by the object. Must specify -b
and -r to export mapping dependencies.
-u xml_output_file_ Required Name of the XML file to contain the object information.
name
-l log_file_name Optional Log file that records each export step. If you omit this option,
status messages output to the window.
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)]
Required/
Option Argument Description
Optional
-c control_file_name Required Name of the control file that defines import options. For
more information, see “Using the Object Import Control
File” on page 303.
-l log_file_name Optional Log file that records each export step. If you omit this
option, status messages output to the window.
Note: The ObjectImport command does not create a folder if the folder name you enter does
not exist in the repository.
Required/
Option Argument Description
Optional
-x local_repository_password Optional 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.
Register 263
Table 6-43. Register Options and Arguments
Required/
Option Argument Description
Optional
-o local_repository_portal_port_nu Conditional Port number for the domain where the local
mber 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.
Required/
Option Argument Description
Optional
-i input_registration_file_name_ Required Name or path of the registration file for the plug-in.
or_path
-l NIS login Optional 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.
RegisterPlugin 265
Table 6-44. RegisterPlugin Options and Arguments
Required/
Option Argument Description
Optional
-k n/a Optional 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.
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.
Required
Option Argument Description
Optional
-g group_name Optional Assigns the user to a group. If you omit this option, the
user is assigned to Public.
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.)|
Required/
Option Argument Description
Optional
-i input_file_name Required Name of the repository backup file. Use a file name and
path local to the Repository Service.
-x confirm_repository_password Optional 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.
Restore 269
Table 6-46. Restore Options and Arguments
Required/
Option Argument Description
Optional
-a n/a Optional 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.
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
To use the RmGroup command, you must have the Admin Repository privilege.
The RmGroup command uses the following syntax:
rmgroup
-g <group_name>
Required/
Option Argument Description
Optional
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>}
Required/
Option Argument Description
Optional
-u repository_user_name Conditional Name of the user from whom you want to remove the
privilege. If you use this option, you cannot use the -g
option.
-g group_name Conditional Name of the group from which you want to remove the
privilege. If you use this option, you cannot use the -u
option.
Required/
Option Argument Description
Optional
-u repository_user_name Required 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>
Required/
Option Argument Description
Optional
-g group_name Required Name of the group from which to remove the user.
Required/
Option Argument Description
Optional
-o output file name Optional 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.
-s n/a Optional Stops running the script after the first error.
-u n/a Optional 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.
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
To replace connections with pmrep, you must have Admin Repository privilege.
Table 6-52 lists pmrep SwitchConnection options and arguments:
Required/
Option Argument Description
Optional
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>]
Required/
Option Argument Description
Optional
-t logs_truncated Required 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.
Required/
Option Argument Description
Optional
-o object_type Required Type of object. You can specify source, target, transformation,
mapping, session, worklet, workflow, scheduler, session config,
task, cube, and dimension.
-t object_subtype Optional Type of transformation or task. Ignored for other object types. For
valid subtypes, see Table 6-36 on page 251.
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)
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-h local_repository_portal_host Conditional Machine name of the domain where the local repository
_name 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.
-o local_repository_portal_port Conditional Port number for the domain where the local repository
_number 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.
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>}]
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-w new_password Conditional 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.
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>]
Required/
Option Argument Description
Optional
-t database_type Required Type of relational connection. For a list of valid database types,
see Table 6-14 on page 214.
-u new_user_name Required User name used for authentication when you connect to the
relational database.
-p new_database_ Optional Password used for authentication when you connect to the
password 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.
Required/
Option Argument Description
Optional
-c new_database_ Required Connect string the Integration Service uses to connect to the
connection_string relational database. For a list of native connect strings, see
Table 6-11 on page 209.
-v new_attribute_value Conditional 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.
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>
Required/
Option Argument Description
Optional
Required/
Option Argument Description
Optional
-m mapping_name Conditional Mapping name. When you update values for a non-
reusable Sequence Generator transformation, you must
include the mapping name.
UpdateSeqGenVals 287
Table 6-59. UpdateSeqGenVals Options and Arguments
Required/
Option Argument Description
Optional
-s start_value Optional 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.
-c current_value Optional 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.
Required/
Option Argument Description
Optional
UpdateSrcPrefix 289
Table 6-60. UpdateSrcPrefix Options and Arguments
Required/
Option Argument Description
Optional
-p prefix_name Required Owner name you want to update in the source table.
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)]
Required/
Option Argument Description
Optional
-p prefix_name Required Table name prefix you want to update in the target table.
-n n/a Optional 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.
Required/
Option Argument Description
Optional
-x repository_ password_ Optional Repository password. You can use the -x or -X option, but
for_confirmation not both. If you do not use the -x or -X option, pmrep
prompts you to enter the repository password for
confirmation.
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>]
Required/
Option Argument Description
Optional
-n object_name Required Name of the object to validate. Do not use this option if
you use the -i argument.
-s n/a Optional Save objects that change from invalid to valid to the
repository.
-u persistent_output_file_name Conditional 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.
-a append Optional Append the results to the persistent output file instead
of overwriting it.
Validate 295
Table 6-63. Validate Options and Arguments
Required/
Option Argument Description
Optional
Version 297
298 Chapter 6: pmrep Commands Reference
Chapter 7
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.
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.
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.
<!--IMPORTPARAMS This inputs the options and inputs required for import operation -->
<!--CHECKIN_AFTER_IMPORT Check in objects on successful import operation -->
<!--CHECKIN_COMMENTS Check in comments -->
<!--APPLY_LABEL_NAME Apply the given label name on imported objects -->
<!--RETAIN_GENERATED_VALUE Retain existing sequence generator, normalizer and XML DSQ
current values in the destination -->
<!--COPY_SAP_PROGRAM Copy SAP program information into the target repository -->
<!--APPLY_DEFAULT_CONNECTION Apply the default connection when a connection used by a
session does not exist in the target repository -->
<!ELEMENT IMPORTPARAMS (FOLDERMAP*, TYPEFILTER*, RESOLVECONFLICT?)>
<!ATTLIST IMPORTPARAMS
CHECKIN_AFTER_IMPORT (YES | NO) "NO"
CHECKIN_COMMENTS CDATA #IMPLIED
APPLY_LABEL_NAME CDATA #IMPLIED
RETAIN_GENERATED_VALUE (YES | NO) "NO"
COPY_SAP_PROGRAM (YES | NO) "YES"
APPLY_DEFAULT_CONNECTION (YES | NO) "NO"
>
<!--FOLDERMAP matches the folders in the imported file with the folders in the target
repository -->
<!ELEMENT FOLDERMAP EMPTY>
<!ATTLIST FOLDERMAP
SOURCEFOLDERNAME CDATA #REQUIRED
SOURCEREPOSITORYNAME CDATA #REQUIRED
TARGETFOLDERNAME CDATA #REQUIRED
TARGETREPOSITORYNAME CDATA #REQUIRED
>
<!--Import will only import the objects in the selected types in TYPEFILTER node -->
<!--TYPENAME type name to import. This should comforming to the element name in
powermart.dtd, e.g. SOURCE, TARGET and etc.-->
<!ELEMENT TYPEFILTER EMPTY>
<!ATTLIST TYPEFILTER
<!--RESOLVECONFLICT allows to specify resolution for conflicting objects during import. The
combination of specified child nodes can be supplied -->
<!ELEMENT RESOLVECONFLICT (LABELOBJECT | QUERYOBJECT | TYPEOBJECT | SPECIFICOBJECT)*>
<!--LABELOBJECT allows objects in the target with label name to apply replace/reuse upon
conflict -->
<!ELEMENT LABELOBJECT EMPTY>
<!ATTLIST LABELOBJECT
LABELNAME CDATA #REQUIRED
RESOLUTION (REPLACE | REUSE | RENAME) #REQUIRED
>
<!--QUERYOBJECT allows objects result from a query to apply replace/reuse upon conflict -->
<!ELEMENT QUERYOBJECT EMPTY>
<!ATTLIST QUERYOBJECT
QUERYNAME CDATA #REQUIRED
RESOLUTION (REPLACE | REUSE | RENAME) #REQUIRED
>
Required/
Element Attribute Name Attribute Description
Optional
RESOLVECONFLICT See LABELOBJECT, n/a You can specify conflict resolutions for
QUERYOBJECT, TYPEOBJECT, objects.
AND SPECIFICOBJECT elements.
Required/
Element Attribute Name Attribute Description
Optional
Table 7-2 lists the object types to use with the OBJECTTYPENAME attribute:
Function Description
Import source objects. Use the TYPEFILTER element to import only source objects. For
more information, see “Importing Source Objects” on page 308.
Import multiple objects into a folder. Use the IMPORTPARAMS and FOLDERMAP elements to import
multiple objects. For more information, see “Importing Multiple
Objects into a Folder” on page 309.
Check in and label imported objects. 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.
Retain Sequence Generator and Normalizer Use the RETAIN_GENERATED_VALUE attribute of the
transformation values. 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.
Import objects and local shortcut objects to the Use all attributes of the FOLDERMAP element to import objects and
same repository. local shortcut objects that reference the objects. For more
information, see “Importing Objects and Local Shortcut Objects to
the Same Repository” on page 310.
Import shortcut objects from another Use all attributes of the FOLDERMAP element to import shortcut
repository. objects from another repository. For more information, see
“Importing Shortcut Objects from Another Repository” on page 310.
Import objects to multiple folders. 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.
Import specific objects. Use the TYPEFILTER element to import specific objects. For more
information, see “Importing Specific Objects” on page 311.
Reuse and replace dependent objects. 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.
Replace invalid mappings. Use the QUERYOBJECT element to replace invalid mappings. For
more information, see “Replacing Invalid Mappings” on page 312.
Function Description
Copy SAP mappings and SAP program Use the COPY_SAP_PROGRAM attribute of the IMPORTPARAMS
information. element to copy SAP mappings and SAP program information. For
more information, see “Copying SAP Mappings and SAP Program
Information” on page 314.
Resolve object conflicts. Use the RESOLVECONFLICT element to resolve object conflicts.
For more information, see “Resolving Object Conflicts” on page 314.
<!-- use the TYPEFILTER element to import only source objects -->
<TYPEFILTER TYPENAME ="SOURCE"/>
<RESOLVECONFLICT>
<LABELOBJECT LABELNAME ="Monthend"
RESOLUTION = "REPLACE"/>
<QUERYOBJECT QUERYNAME ="yr_end_qry"
RESOLUTION ="RENAME"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>
<!-- import objects from SRC_SHARED_F1 to TGT_SHARED_F1, and shortcut objects from
SRC_NONSHARED_F1 to TGT_NONSHARED_F1-->
<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>
<!-- import objects from source folders SRC_F1, SRC_F2, and SRC_F3 to target folders
TGT_F1, TGT_F2, and TGT_F3 in repository TGT_REPO1 -->
<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>
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES"
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:
<?xml version="1.0" encoding="UTF-8"?>
<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>
<!-- rename the objects ADDRESS, ADDRESS1, R_LKP, MAP_MLET, R_S3, WF_RS1 -->
<!-- enter YES as the value for the COPY_SAP_PROGRAM attribute to copy SAP mappings and SAP
program information -->
<!-- enter YES as the value of the APPLY_DEFAULT_CONNECTION element to apply a default
connection attribute -->
<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>
<!-- use the RESOLVECONFLICT element in conjunction with the RESOLUTION attribute of the
OBJECTTYPENAME element to resolve conflicts when you import objects -->
<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>
<!--folder to replace-->
<!ELEMENT REPLACEFOLDER EMPTY>
<!ATTLIST REPLACEFOLDER
FOLDERNAME CDATA #REQUIRED
RETAINMAPVARPERVALS (YES | NO) "NO"
Required/
Element Attribute Name Attribute Description
Optional
Required/
Element Attribute Name Attribute Description
Optional
Required/
Element Attribute Name Attribute Description
Optional
</DEPLOYPARAMS>
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.
A AssignLicense (infacmd)
description 33
AbortTask (pmcmd) AssignRSToWSHubService (infacmd)
description 143 description 35
AbortWorkflow (pmcmd)
description 145
AddDomainLink (infacmd) B
description 25
BackUp (pmrep)
AddDomainNode (infacmd)
description 204
description 27
BackupDomain (infasetup)
AddLicense (infacmd)
description 117
description 28
AddNodeResource (infacmd)
description 30
AddPrivilege (pmrep)
C
description 198 CheckIn (pmrep)
AddToDeploymentGroup (pmrep) description 206
description 199 CleanUp (pmrep)
AddUserToGroup (pmrep) description 207
description 201 ClearDeploymentGroup (pmrep)
application services description 208
disabling using infacmd 55 command line mode for pmcmd
enabling using infacmd 60 connecting 134
getting status using infacmd 71 Connect (pmcmd)
removing using infacmd 90 description 147
ApplyLabel (pmrep) Connect (pmrep)
description 202 description 209
AssignedToLicense (infacmd) connect string
description 32 examples 192
325
syntax 192 description 227
connectivity depcntl.dtd
connect string examples 192 listing 316
control file DeployDeploymentGroup (pmrep)
deployment 316 description 228
object import 303 DeployFolder (pmrep)
ObjectImport XML example 307 description 230
ConvertLogFile (infacmd) deploying objects
description 37 depcntl.dtd 316
Create (pmrep) deployment groups
description 211 listing multiple folders 322
CreateConnection (pmrep) DisableNodeResource (infacmd)
description 212 description 53
CreateDeploymentGroup (pmrep) DisableService (infacmd)
description 217 description 55
CreateFolder (pmrep) DisableServiceProcess (infacmd)
description 218 description 56
CreateGrid (infacmd) Disconnect (pmcmd)
description 38 description 148
CreateGroup (pmrep) domain password
description 220 changing using infacmd 99
CreateIntegrationService (infacmd) domains
description 39 backing up using infasetup 117
CreateLabel (pmrep) creating using infasetup 119
description 221 linking using infacmd 25
CreateRepositoryService (infacmd) listing linked domains using infacmd 77
description 46 removing links using infacmd 83
CreateUser (pmrep) restoring using infasetup 127
description 222 DTD file
CreateWSHubService (infacmd) plug-in template 266
description 50
E
D EditUser (pmrep)
DB2 description 232
See IBM DB2 EnableNodeResource (infacmd)
DefineDomain (infasetup) description 58
description 119 EnableService (infacmd)
DefineGatewayNode (infasetup) description 60
description 122 EnableServiceProcess (infacmd)
DefineWorkerNode (infasetup) description 61
description 124 environment variables
Delete (pmrep) INFA_CLIENT_RESILIENCE_TIMEOUT 8
description 223 INFA_CODEPAGENAME 9
DeleteConnection (pmrep) INFA_DEFAULT_DATABASE_PASSWORD 10
description 224 INFA_DEFAULT_DOMAIN 11
DeleteDeploymentGroup (pmrep) INFA_DEFAULT_DOMAIN_PASSWORD 12
description 225 INFA_DEFAULT_DOMAIN_USER 13
DeleteFolder (pmrep) INFA_REPCNX_INFO 14
description 226 INFATOOL_DATEFORMAT 15
DeleteLabel (pmrep) error messages
326 Index
fetching using infacmd 62 description 74
ExecuteQuery (pmrep) grids
description 234 creating using infacmd 38
Exit (pmrep) listing nodes using infacmd 78
description 236 removing using infacmd 84
external security module updating assigned nodes using infacmd 101
registering 266
external security modules
unregistering 283 H
Help (infacmd)
F description 76
Help (pmcmd)
FindCheckout (pmrep) description 161
description 237 Help (pmrep)
folders description 239
deleting 226
deploying 230
modifying 258 I
IBM DB2
G connect string example 192
importing objects
gateway impcntl.dtd 303
updating information using infacmd 100 ObjectImport XML example 307
GetLastError (infacmd) INFA_CLIENT_RESILIENCE_TIMEOUT
description 62 configuring 8
GetLog (infacmd) INFA_CODEPAGENAME
description 64 configuring 9
GetRunningSessionsDetails (pmcmd) INFA_DEFAULT_DATABASE_PASSWORD
description 150 configuring 10
GetServiceDetails (pmcmd) INFA_DEFAULT_DOMAIN
description 152 configuring 11
GetServiceOption (infacmd) INFA_DEFAULT_DOMAIN_PASSWORD
description 67 configuring 12
GetServiceProcessOption (infacmd) INFA_DEFAULT_DOMAIN_USER
description 69 configuring 13
GetServiceProcessStatus (infacmd) INFA_REPCNX_INFO
description 70 configuring 14
GetServiceProperties (pmcmd) infacmd
description 154 domains, linking 25
GetServiceStatus (infacmd) domains, listing linked domains 77
description 71 domains, removing links 83
GetSessionLog (infacmd) error messages, fetching 62
description 72 gateway information, updating 100
GetSessionStatistics (pmcmd) grids, creating 38
description 155 grids, listing nodes 78
GetTaskDetails (pmcmd) grids, removing 84
description 157 grids, updating assigned nodes 101
GetWorkflowDetails (pmcmd) help 76
description 159 Integration Service options 41
GetWorkflowLog (infacmd) Integration Services, creating 39
Index 327
Integration Services, updating 102 gateway nodes, defining 122
licenses, adding 28 gateway nodes, updating 129
licenses, assigning to services 33 return codes 114
licenses, displaying information 91 worker nodes, defining 124
licenses, listing 79 worker nodes, updating 131
licenses, listing services 32 INFATOOL_DATEFORMAT
licenses, removing 85 configuring 15
licenses, unassigning 93 Integration Service
licenses, updating 104 creating using infacmd 39
log events, fetching 64 disabling using infacmd 55
log events, purging 82 enabling using infacmd 60
log files, converting to binary 37 getting status using infacmd 71
nodes, adding to domains 27 removing using infacmd 90
nodes, disassociating from domains 97 updating using infacmd 102
nodes, removing 87 interactive mode for pmcmd
nodes, shutting down 92 connecting 136
nodes, updating 105 setting defaults 136
passwords, updating 99
pinging objects 81
Repository Service options 47 K
Repository Services, creating 46
KillUserConnection (pmrep)
Repository Services, updating 107
description 240
resources, adding to nodes 30
resources, disabling on nodes 53
resources, enabling on nodes 58
resources, listing for nodes 80
L
resources, removing from nodes 88 labels
return codes 21 creating 221
service options, fetching 67 deleting 227
service process options 44 licenses
service process options, fetching 69 adding using infacmd 28
service process status, fetching 70 assigning using infacmd 33
service processes, disabling 56 displaying using infacmd 91
service processes, enabling 61 listing services using infacmd 32
service processes, updating 109 listing using infacmd 79
service status, fetching 71 removing using infacmd 85
services, disabling 55 unassigning using infacmd 93
services, enabling 60 updating using infacmd 104
services, removing 90 ListAllGroups (pmrep)
session logs, fetching 72 description 241
Web Service Hub Service options 51 ListAllPrivileges (pmrep)
Web Service Hub Services, associating a repository 35 description 242
Web Service Hub Services, creating 50 ListAllUsers (pmrep)
Web Service Hub Services, disassociating a repository description 243, 244
95 ListDomainLinks (infacmd)
Web Service Hub Services, updating 111 description 77
workflow logs, fetching 74 ListGridNodes (infacmd)
infasetup description 78
domains, backing up 117 ListGroupsForUser (pmrep)
domains, defining 119 description 244
domains, restoring 127 ListLicenses (infacmd)
328 Index
description 79 objects
ListNodeResources (infacmd) checking in 206
description 80 exporting 260
ListObjectDependencies (pmrep) importing 262
description 245 Oracle
ListObjects (pmrep) connect string syntax 192
description 248 OVERRIDEFOLDER
listing folders 252 sample control file 322
transformation types 251
ListTablesBySess (pmrep)
description 254 P
ListUserConnections (pmrep)
parameter files
description 256
using with pmcmd StartTask 172
local parameter files
using with pmcmd StartWorkflow 175
using with pmcmd StartWorkflow 175
passwords
log events
changing using infacmd 99
converting using infacmd 37
persistent input file
fetching using infacmd 64
creating with pmrep 301
purging using infacmd 82
Ping (infacmd)
truncating using pmrep 278
description 81
LsPrivileges (pmrep)
PingService (pmcmd)
description 257
description 162
plug-ins
M pmcmd
XML templates 266
Index 329
workflows, determining if running 187 overview 190
workflows, getting details about 152, 159 persistent input files, creating 301
workflows, recovering 163 plug-ins, registering 265
workflows, removing from a schedule 181 plug-ins, unregistering 282
workflows, scheduling 165 privileges, adding 198
workflows, starting 174 privileges, listing 242
workflows, stopping 179 privileges, listing for user or group 257
pmrep privileges, removing 272
checked-out objects, listing 237 queries, executing 234
checkouts, undoing 279 repositories, backing up 204
command line mode 190 repositories, connecting to 209
connection information, showing 276 repositories, creating 211
connection name, changing 277 repositories, deleting 223
connections, creating 212 repositories, registering 263
connections, deleting 224 repositories, restoring 268
connections, updating 284 repositories, unregistering 280
deployment control parameters 318 repositories, upgrading 293
deployment groups, adding objects to 199 repository connection file, specifying 14
deployment groups, clearing objects from 208 repository statistics, updating 291
deployment groups, creating 217 resources, cleaning up 207
deployment groups, deleting 225 script files 192
deployment groups, deploying 228 scripts, running 275
email addresses, updating 286 sequence values, updating 287
folder properties, modifying 258 table owner names, updating 289
folders, creating 218 tables, listing by session 254
folders, deleting 226 target table name prefixes, updating 292
folders, deploying 230 user connections, listing 256
folders, listing 252 user connections, terminating 240
folders, modifying properties 258 user information, editing 232
groups, adding users to 201 user properties, editing 232
groups, creating 220 users, adding to repositories 222
groups, listing 241 users, creating 222
groups, listing for user 244 users, listing 243, 244, 243
groups, removing 271 users, registering 267
groups, removing users from 274 users, removing 273
help 239 users, removing from groups 274
interactive mode 190 version information, displaying 297
interactive mode, exiting 236 post-session email
interactive mode, exiting from 236 updating addresses with pmrep 286
labels, applying 202 privileges
labels, creating 221 removing 272
labels, deleting 227 PurgeLog (infacmd)
logs, deleting 278 description 82
notification messages, sending 259
object dependencies, listing 245
object import control parameters 305 Q
objects, checking in 206
queries
objects, exporting 260
executing 234
objects, importing 262
objects, listing 248
objects, validating 294
330 Index
R return codes
infacmd 21
RecoverWorkflow (pmcmd) infasetup 114
description 163 pmcmd 135
Register (pmrep) RmGroup (pmrep)
description 263 description 271
registering RmPrivilege (pmrep)
a user 267 description 272
plug-in using pmrep 265 RmUser (pmrep)
security module using pmrep 266 description 273
RegisterPlugin (pmrep) RmUserFromGroup (pmrep)
description 265 description 274
RegisterUser (pmrep) Run (pmrep)
description 267 description 275
RemoveDomainLink (infacmd)
description 83
RemoveGrid (infacmd) S
description 84
ScheduleWorkflow (pmcmd)
RemoveLicense (infacmd)
description 165
description 85
script files
RemoveNode (infacmd)
running 275
description 87
service options
RemoveNodeResource (infacmd)
fetching using infacmd 67
description 88
service process options
RemoveService (infacmd)
fetching using infacmd 69
description 90
session logs
repositories
fetching using infacmd 72
backing up using pmrep 204
SetFolder (pmcmd)
creating relational 212
description 167
deleting details from 278
SetNoWait (pmcmd)
registering 263
description 168
unregistering 280
SetWait (pmcmd)
Repository Service
description 169
creating using infacmd 46
ShowConnectionInfo (pmrep)
disabling using infacmd 55
description 276
enabling using infacmd 60
ShowLicense (infacmd)
getting status using infacmd 71
description 91
removing using infacmd 90
ShowSettings (pmcmd)
updating using infacmd 107
description 170
resources
ShutdownNode (infacmd)
defining using infacmd 30
description 92
disabling using infacmd 53
StartTask (pmcmd)
enabling using infacmd 58
description 171
removing using infacmd 88
using a parameter file 172
viewing using infacmd 80
StartWorkflow (pmcmd)
Restore (pmrep)
description 174
description 268
using a parameter file 175
RestoreDomain (infasetup)
statistics
description 127
updating repository 291
restoring
StopTask (pmcmd)
repositories using pmrep Restore 268
description 177
Index 331
StopWorkflow (pmcmd) UpdateRepositoryService (infacmd)
description 179 description 107
SwitchConnection (pmrep) UpdateSeqGenVals (pmrep)
description 277 description 287
syntax UpdateServiceProcess (infacmd)
command line programs 3 description 109
UpdateSrcPrefix (pmrep)
description 289
T updating non-reusable sessions 289
UpdateStatistics (pmrep)
table owner name
description 291
updating with pmrep 289
UpdateTargetPrefix (pmrep)
TruncateLog (pmrep)
description 292
description 278
updating non-reusable sessions 292
UpdateWorkerNode (infasetup)
U description 131
UpdateWSHubService (infacmd)
UnassignLicense (infacmd) description 111
description 93 Upgrade (pmrep)
UnassignRSWSHubService (infacmd) description 293
description 95
UnassociateDomainNode (infacmd)
description 97 V
UndoCheckout (pmrep)
Validate (pmrep)
description 279
description 294
Unregister (pmrep)
validating objects
description 280
with pmrep 294
UnregisterPlugin (pmrep)
Version (pmcmd)
description 282
description 184
UnscheduleWorkflow (pmcmd)
Version (pmrep)
description 181
description 297
UnsetFolder (pmcmd)
description 183
UpdateConnection (pmrep)
description 284
W
UpdateDomainPassword (infacmd) WaitTask (pmcmd)
description 99 description 185
UpdateEmailAddr (pmrep) WaitWorkflow (pmcmd)
description 286 description 187
UpdateGatewayInfo (infacmd) Web Service Hub Services
description 100 associating a repository using infacmd 35
UpdateGatewayNode (infasetup) creating using infacmd 50
description 129 disassociating a repository using infacmd 95
UpdateGrid (infacmd) updating using infacmd 111
description 101 workflow logs
UpdateIntegrationService (infacmd) fetching using infacmd 74
description 102 workflows
UpdateLicense (infacmd) recovering using pmcmd syntax 163
description 104
UpdateNodeOptions (infacmd)
description 105
332 Index
X
XML file
plug-in templates 266
Index 333
334 Index