0% found this document useful (0 votes)

162 views316 pages

PC 861 CommandReference

ref

Uploaded by

vicky

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

162 views316 pages

PC 861 CommandReference

ref

Uploaded by

vicky

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Command Reference

Informatica PowerCenter
(Version 8.6.1)

Informatica PowerCenter Command Reference

Version 8.6.1
February 2009
Copyright (c) 19982009 Informatica Corporation. All rights reserved.
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. This Software may be protected by U.S. and/or international Patents and other Patents Pending.
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 product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing.
Informatica, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer,
Informatica B2B Data Exchange and Informatica On Demand 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. All rights reserved. Copyright 2007
Adobe Systems Incorporated. All rights reserved. Copyright Sun Microsystems. All rights reserved. Copyright RSA Security Inc. All Rights Reserved. Copyright Ordinal Technology Corp. All
rights reserved. Copyright Platon Data Technology GmbH. All rights reserved. Copyright Melissa Data Corporation. All rights reserved. Copyright Aandacht c.v. All rights reserved. Copyright
1996-2007 ComponentSource. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright 2007 Isomorphic Software. All rights reserved. Copyright Meta Integration Technology,
Inc. All rights reserved. Copyright Microsoft. All rights reserved. Copyright Oracle. All rights reserved. Copyright AKS-Labs. All rights reserved. Copyright Quovadx, Inc. All rights reserved.
Copyright SAP. All rights reserved. Copyright 2003, 2007 Instantiations, Inc. All rights reserved. Copyright Intalio. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/), software copyright 2004-2005 Open Symphony (all rights reserved) and other software which is
licensed under the Apache License, Version 2.0 (the License). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in
writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software copyright, Red Hat Middleware, LLC,
all rights reserved; software copyright 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under the GNU Lesser General Public License Agreement, which may be
found at http://www.gnu.org/licenses/lgpl.html. The 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.
The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt
University, Copyright (c) 1993-2006, all rights reserved.
This product includes software copyright (c) 2003-2007, Terence Parr. All rights reserved. Your right to use such materials is set forth in the license which may be found at http://www.antlr.org/
license.html. The 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.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to
terms available at http://www.openssl.org.
This product includes Curl software which is Copyright 1996-2007, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms
available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright
notice and this permission notice appear in all copies.
The product includes software copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://www.dom4j.org/
license.html.
The product includes software copyright (c) 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://
svn.dojotoolkit.org/dojo/trunk/LICENSE.
This product includes ICU software which is copyright (c) 1995-2003 International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software
are subject to terms available at http://www-306.ibm.com/software/globalization/icu/license.jsp
This product includes software copyright (C) 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at http://www.gnu.org/software/
kawa/Software-License.html.
This product includes OSSP UUID software which is Copyright (c) 2002 Ralf S. Engelschall, Copyright (c) 2002 The OSSP Project Copyright (c) 2002 Cable & Wireless Deutschland. Permissions and
limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at http:/
/www.boost.org/LICENSE_1_0.txt.
This product includes software copyright 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at http://www.pcre.org/license.txt.
This product includes software copyright (c) 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://
www.eclipse.org/org/documents/epl-v10.php.
The product includes the zlib library copyright (c) 1995-2005 Jean-loup Gailly and Mark Adler.
This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html.
This product includes software licensed under the terms at http://www.bosrup.com/web/overlib/?License.
This product includes software licensed under the terms at http://www.stlport.org/doc/license.html.
This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php). This product includes software copyright 2003-2006 Joe WaInes, 20062007 XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes
software developed by the Indiana University Extreme! Lab. For further information please visit http://www.extreme.indiana.edu/.
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; 6,850,947; 6,895,471; 7,254,590 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 noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. The information provided in this software or
documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice.

Part Number: PC-CLR-86100-0006

Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica Customer Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica How-To Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Informatica Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Informatica Multimedia Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Informatica Global Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

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

Using Command Line Programs Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Entering Options and Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Syntax Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2: Configuring Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Configuring Environment Variables Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
INFA_CLIENT_RESILIENCE_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
INFA_CODEPAGENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
INFA_DEFAULT_DATABASE_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
INFA_DEFAULT_DOMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
INFA_DEFAULT_DOMAIN_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
INFA_DEFAULT_DOMAIN_USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
INFA_REPCNX_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
INFATOOL_DATEFORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Encrypting Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Using a Password as an Environment Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Setting the User Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 3: infacmd Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Using infacmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
AddAlertUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
AddDomainLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
AddDomainNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
AddGroupPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
AddGroupPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
AddLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
AddNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
AddRolePrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
AddServiceLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
iii

AddUserPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
AddUserPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
AddUserToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
AssignedToLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
AssignISToMMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
AssignLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
AssignRoleToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
AssignRoleToUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
AssignRSToWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
BackupDARepositoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ConvertLogFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CreateDARepositoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CreateFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
CreateGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
CreateIntegrationService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Integration Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Integration Service Process Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
CreateMMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Metadata Manager Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CreateOSProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Integration Service Process Options for Operating System Profiles . . . . . . . . . . . . . . . . . 48
CreateReportingService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Reporting Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Reporting Source Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Lineage Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
CreateRepositoryService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Repository Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
CreateRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
CreateRTMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Reference Table Manager Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
CreateSAPBWService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
SAP BW Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
SAP BW Service Process Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
CreateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
CreateWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Web Services Hub Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
DeleteDARepositoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
DisableNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
DisableService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
DisableServiceProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DisableUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
EditUser

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

EnableNodeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
EnableService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
EnableServiceProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
iv

Table of Contents

EnableUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
ExportUsersAndGroups

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

GetFolderInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
GetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
GetLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
GetNodeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
GetServiceOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
GetServiceProcessOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
GetServiceProcessStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
GetServiceStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
GetSessionLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
GetWorkflowLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ImportUsersAndGroups

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

ListAlertUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
ListAllGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
ListAllRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
ListAllUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
ListDomainLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
ListDomainOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
ListFolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
ListGridNodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ListGroupPrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ListLDAPConnectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ListLicenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ListNodeOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
ListNodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ListNodeResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ListOSProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ListRepositoryLDAPConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
ListRolePrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
ListSecurityDomains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ListServiceLevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
ListServiceNodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
ListServicePrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
ListServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ListSMTPOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ListUserPrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
MoveFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
MoveObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
PurgeLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
RemoveAlertUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
RemoveDomainLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
RemoveFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
RemoveGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
v

Table of Contents

RemoveGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
RemoveGroupPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
RemoveLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
RemoveNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
RemoveNodeResource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
RemoveOSProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
RemoveRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
RemoveRolePrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
RemoveService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
RemoveServiceLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
RemoveUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
RemoveUserFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
RemoveUserPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ResetPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
RestoreDARepositoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
RunCPUProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
SetLDAPConnectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
SetRepositoryLDAPConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ShowLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ShutdownNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
SwitchToGatewayNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
SwitchToWorkerNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
UnassignISMMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
UnassignLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
UnAssignRoleFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
UnAssignRoleFromUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
UnassignRSWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
UnassociateDomainNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
UpdateDomainOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
UpdateDomainPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
UpdateFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
UpdateGatewayInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
UpdateGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
UpdateIntegrationService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
UpdateLicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
UpdateMMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
UpdateNodeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
UpdateOSProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
UpdateReportingService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
UpdateRepositoryService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
UpdateRTMService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
UpdateSAPBWService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
UpdateServiceLevel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
UpdateServiceProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
UpdateSMTPOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
UpdateWSHubService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
vi

Working with pmrep Files Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Using the Persistent Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Creating a Persistent Input File with pmrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Creating a Persistent Input File Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Using the Object Import Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Object Import Control File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Object Import Control File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Importing Source Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Importing Multiple Objects into a Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Checking In and Labeling Imported Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Retaining Sequence Generator and Normalizer Values . . . . . . . . . . . . . . . . . . . . . . . . . 282
Importing Objects and Local Shortcut Objects to the Same Repository . . . . . . . . . . . . . 282
Importing Shortcut Objects from Another Repository . . . . . . . . . . . . . . . . . . . . . . . . . 282
Importing Objects to Multiple Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Importing Specific Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Reusing and Replacing Dependent Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Replacing Invalid Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Renaming Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Copying SAP Mappings and SAP Program Information . . . . . . . . . . . . . . . . . . . . . . . . 285
Applying Default Connection Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Resolving Object Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Using the Deployment Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Deployment Control File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Deployment Control File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Deploying the Latest Version of a Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Deploying the Latest Version of a Deployment Group . . . . . . . . . . . . . . . . . . . . . . . . . 290
Listing Multiple Source and Target Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Table of Contents

Preface
The PowerCenter Command 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.

Informatica Resources
Informatica Customer Portal
As an Informatica customer, you can access the Informatica Customer Portal site at http://my.informatica.com.
The site contains product information, user group information, newsletters, access to the Informatica customer
support case management system (ATLAS), the Informatica How-To Library, the Informatica Knowledge Base,
the Informatica Multimedia Knowledge Base, Informatica Documentation Center, and access to the
Informatica user community.

Informatica Documentation
The Informatica Documentation team takes every effort to create accurate, usable documentation. If you have
questions, comments, or ideas about this documentation, contact the Informatica Documentation team
through email at [email protected]. We will use your feedback to improve our
documentation. Let us know if we can contact you regarding your comments.
The Documentation team updates documentation as needed. To get the latest documentation for your product,
navigate to the Informatica Documentation Center from http://my.informatica.com.

Informatica Web Site

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

Informatica How-To Library

As an Informatica customer, you can access the Informatica How-To Library at http://my.informatica.com. The
How-To Library is a collection of resources to help you learn more about Informatica products and features. It

includes articles and interactive demonstrations that provide solutions to common problems, compare features
and behaviors, and guide you through performing specific real-world tasks.

Informatica Knowledge Base

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

Informatica Multimedia Knowledge Base

As an Informatica customer, you can access the Informatica Multimedia Knowledge Base at
http://my.informatica.com. The Multimedia Knowledge Base is a collection of instructional multimedia files
that help you learn about common concepts and guide you through performing specific tasks. If you have
questions, comments, or ideas about the Multimedia Knowledge Base, contact us through email at
[email protected].

Informatica Global Customer Support

There are many ways to access Informatica Global Customer Support. You can contact a Customer Support
Center through telephone, email, or the WebSupport Service.
Use the following email addresses to contact Informatica Global Customer 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.
Use the following telephone numbers to contact Informatica Global Customer Support:

xii

Preface

North America / South America

Europe / Middle East / Africa

Asia / Australia

Informatica Corporation
Headquarters
100 Cardinal Way
Redwood City, California
94063
United States

Informatica Software Ltd.

6 Waltham Park
Waltham Road, White Waltham
Maidenhead, Berkshire
SL6 3TN
United Kingdom

Informatica Business
Solutions Pvt. Ltd.
Diamond District
Tower B, 3rd Floor
150 Airport Road
Bangalore 560 008
India

Toll Free
+1 877 463 2435

Toll Free
00 800 4632 4357

Toll Free
Australia: 1 800 151 830
Singapore: 001 800 4632
4357

Standard Rate
Brazil: +55 11 3523 7761
Mexico: +52 55 1168 9763
United States: +1 650 385 5800

Standard Rate
Belgium: +32 15 281 702
France: +33 1 41 38 92 26
Germany: +49 1805 702 702
Netherlands: +31 306 022 797
Spain and Portugal: +34 93 480 3760
United Kingdom: +44 1628 511 445

Standard Rate
India: +91 80 4112 5738

CHAPTER 1

Using the Command Line Programs

This chapter includes the following topic:

Using Command Line Programs Overview, 1

Using Command Line Programs 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 Command Reference on page 11.

infasetup. Use infasetup to perform installation tasks such as defining a node or a domain. For more
information about infasetup, infasetup Command Reference on page 167.

pmcmd. Use pmcmd to manage workflows. You can start, stop, schedule, and monitor workflows using
pmcmd. For more information about pmcmd, see pmcmd Command Reference on page 183.

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
Command Reference on page 217.

To run command line programs on UNIX, you may need to set the library path environment variable to the
location of the PowerCenter utilities.
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, user, and password
to avoid typing the options at the command line.

Entering Options and Arguments

Each command line program requires a set of options and arguments. These include user name, password,
domain name, and connection information.
Use the following rules when you enter command options and arguments:

To enter options, type a hyphen followed by one letter, two letters, or a word, depending on the command
line program syntax.

For example, the pmrep Connect command uses a single letter option for the repository name:
connect -r <repository_name>

Enter options in any order.

The first word after the option is the argument.

Most options require arguments. You must separate options from arguments with a single space when using
pmcmd or infacmd. You do not have to separate options from arguments when using pmrep.

If any argument contains more than one word, enclose the argument in double quotes. For pmcmd, you can
also use single quotes. The command line programs ignore quotes that do not enclose an argument.
Unmatched quotes result in an error.

Syntax Notation
The following table 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.

Select between required options. For the command to run, you must select
from the listed options. If you omit a required option, the command line
program returns an error message.
In pmrep, curly brackets denote groupings of required options, as in the
following example:

{x | y}

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.

Chapter 1: Using the Command Line Programs

CHAPTER 2

Configuring Environment Variables

This chapter includes the following topics:

Configuring Environment Variables Overview, 3

INFA_CLIENT_RESILIENCE_TIMEOUT, 4

INFA_CODEPAGENAME, 5

INFA_DEFAULT_DATABASE_PASSWORD, 6

INFA_DEFAULT_DOMAIN, 6

INFA_DEFAULT_DOMAIN_PASSWORD, 7

INFA_DEFAULT_DOMAIN_USER, 8

INFA_REPCNX_INFO, 8

INFATOOL_DATEFORMAT, 9

Encrypting Passwords, 9

Setting the User Name, 10

Configuring Environment Variables 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.
Note: The environment variables that you configure apply to command line programs that run on the node. To
apply changes, restart the node.

The following table describes environment variables you can configure to use with the command line programs:

Environment Variable

Command
Line
Programs

Description

INFA_CLIENT_RESILIENCE_TIMEOUT

infacmd
pmcmd
pmrep

Limits the number of seconds you want the

command line programs to spend
establishing a connection to the domain or
service. For more information, see
INFA_CLIENT_RESILIENCE_TIMEOUT
on page 4.

INFA_CODEPAGENAME

pmcmd
pmrep

Configures the character set pmcmd and

pmrep use. For more information, see
INFA_CODEPAGENAME on page 5.

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 6.

INFA_DEFAULT_DOMAIN

infacmd
pmcmd
pmrep

Stores the default domain name. For more

information, see
INFA_DEFAULT_DOMAIN on page 6.

INFA_DEFAULT_DOMAIN_PASSWORD

infacmd

Stores the default user name password for

the domain. For more information, see
INFA_DEFAULT_DOMAIN_PASSWORD
on page 7.

INFA_DEFAULT_DOMAIN_USER

infacmd

Stores the default user name for the

domain. For more information, see
INFA_DEFAULT_DOMAIN_USER on
page 8.

INFA_REPCNX_INFO

pmrep

Stores the name of the repository

connection file. For more information, see
INFA_REPCNX_INFO on page 8.

INFATOOL_DATEFORMAT

pmcmd

Configures the way pmcmd displays the

date and time. For more information, see
INFATOOL_DATEFORMAT on page 9.

<Password_Environment_Variable>

pmcmd
pmrep

Encrypts and stores the password. For more

information, see Encrypting Passwords on
page 9.

<User_Name_Environment_Variable>

pmcmd
pmrep

Stores the user name. For more information,

see Setting the User Name on page 10.

INFA_CLIENT_RESILIENCE_TIMEOUT
Command Line Programs:
infacmd
pmcmd
pmrep

You can set the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT to limit the number of
seconds the command line programs spend establishing connections to the domain or service. The default time
is 180 seconds if you do not set this environment variable.

Chapter 2: Configuring Environment Variables

To configure INFA_CLIENT_RESILIENCE_TIMEOUT on UNIX:

In a UNIX C shell environment, type:

setenv INFA_CLIENT_RESILIENCE_TIMEOUT <number of seconds>

In a UNIX Bourne shell environment, type:

INFA_CLIENT_RESILIENCE_TIMEOUT = <number of seconds>
export INFA_CLIENT_RESILIENCE_TIMEOUT
To configure INFA_CLIENT_RESILIENCE_TIMEOUT on Windows:
X

Enter the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT, and set the value to the
number of seconds you want the command line programs to spend establishing a connection to the domain
or service.
For information about setting environment variables on Windows, consult the Windows documentation.

INFA_CODEPAGENAME
Command Line Programs:
pmcmd
pmrep

pmcmd and pmrep send commands in Unicode and use the code page of the host machine unless you set the
code page environment variable, INFA_CODEPAGENAME, to override it. If you set
INFA_CODEPAGENAME for pmcmd, the code page must be compatible with the Integration Service code
page. If you set INFA_CODEPAGENAME for pmrep, the code page name must be compatible with the
repository code page. If you set INFA_CODEPAGENAME on the machine where you run pmcmd and pmrep,
the code page must be compatible with the Integration Service and the repository code pages.
If the code pages are not compatible, the command might fail. For more information about code page
compatibility, see the PowerCenter Administrator Guide.
To configure INFA_CODEPAGENAME on UNIX:
X

In a UNIX C shell environment, type:

setenv INFA_CODEPAGENAME <code page name>

In a UNIX Bourne shell environment, type:

INFA_CODEPAGENAME = <code page name>
export INFA_CODEPAGENAME
To configure INFA_CODEPAGENAME on Windows:
X

Enter the environment variable INFA_CODEPAGENAME, and set the value to the code page name.
For information about setting environment variables on Windows, consult the Windows documentation.

INFA_CODEPAGENAME

INFA_DEFAULT_DATABASE_PASSWORD
Command Line Program:
infasetup

Some infasetup commands require a domain configuration database password. You can provide this password as
an option with infasetup, or you can store it as the environment variable
INFA_DEFAULT_DATABASE_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1.

Use the command line program pmpasswd to encrypt the database user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password monday,
it encrypts to f/wRb5PZsZnqESTDPeos7Q==.

Configure the password environment variable to set the encrypted value.

To configure INFA_DEFAULT_DATABASE_PASSWORD on UNIX:

At the command line, type:

pmpasswd <database password>

pmpasswd returns the encrypted password.

In a UNIX C shell environment, type:

setenv INFA_DEFAULT_DATABASE_PASSWORD <encrypted password>

In a UNIX Bourne shell environment, type:

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

At the command line, type:

pmpasswd <database password>

pmpasswd returns the encrypted password.

Enter the environment variable INFA_DEFAULT_DATABASE_PASSWORD, and set the value to the
encrypted password.
For information about setting environment variables on Windows, consult the Windows documentation.

INFA_DEFAULT_DOMAIN
Command Line Programs:
infacmd
pmcmd
pmrep

The command line programs require a domain name. You can provide the domain name as an option with the
command line programs, or you can store it as the environment variable INFA_DEFAULT_DOMAIN. If you
have more than one domain, choose a default domain.
To configure INFA_DEFAULT_DOMAIN on UNIX:
X

In a UNIX C shell environment, type:

setenv INFA_DEFAULT_DOMAIN <domain name>

Chapter 2: Configuring Environment Variables

In a UNIX Bourne shell environment, type:

INFA_DEFAULT_DOMAIN = <domain name>
export INFA_DEFAULT_DOMAIN
To configure INFA_DEFAULT_DOMAIN on Windows:
X

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_PASSWORD
Command Line Program:
infacmd

Most infacmd commands require a user password. You can provide a 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 user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password monday,
it encrypts to f/wRb5PZsZnqESTDPeos7Q==.

Configure the password environment variable to set the encrypted value.

To configure INFA_DEFAULT_DOMAIN_PASSWORD on UNIX:

At the command line, type:

pmpasswd <password>

pmpasswd returns the encrypted password.

In a UNIX C shell environment, type:

setenv INFA_DEFAULT_DOMAIN_PASSWORD <encrypted password>

In a UNIX Bourne shell environment, type:

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

At the command line, type:

pmpasswd <password>

pmpasswd returns the encrypted password.

Enter the environment variable INFA_DEFAULT_DOMAIN_PASSWORD, and set the value to the
encrypted password.
For information about setting environment variables on Windows, consult the Windows documentation.

INFA_DEFAULT_DOMAIN_PASSWORD

INFA_DEFAULT_DOMAIN_USER
Command Line Program:
infacmd

Most infacmd commands require a user name. You can provide a user name as an option with infacmd, or you
can store it as the environment variable INFA_DEFAULT_DOMAIN_USER.
To configure INFA_DEFAULT_DOMAIN_USER on UNIX:
X

In a UNIX C shell environment, type:

setenv INFA_DEFAULT_DOMAIN_USER <user name>

In a UNIX Bourne shell environment, type:

INFA_DEFAULT_DOMAIN_USER = <user name>
export INFA_DEFAULT_DOMAIN_USER
To configure INFA_DEFAULT_DOMAIN_USER on Windows:
X

Enter the environment variable INFA_DEFAULT_DOMAIN_USER, and set the value to the default user
name.
For information about setting environment variables on Windows, consult the Windows documentation.

INFA_REPCNX_INFO
Command Line Program:
pmrep

When you run pmrep in command line mode or from a script, it stores repository connection information in a
file, pmrep.cnx. pmrep uses the information in this file to reconnect to the repository. The
INFA_REPCNX_INFO environment variable stores the file name and file path for the repository connection
file.
Use this variable when scripts that issue pmrep commands run simultaneously, and the scripts connect to
different repositories. In each shell, specify a different repository connection file. This prevents a script from
overwriting the connection information used by another script.
If you do not set this variable, pmrep stores connection information in pmrep.cnx in the directory where you
start pmrep.
To configure INFA_REPCNX_INFO on UNIX:
X

In a UNIX C shell environment, type:

setenv INFA_REPCNX_INFO <file name>

In a UNIX Bourne shell environment, type:

INFA_REPCNX_INFO = <file name>
export INFA_REPCNX_INFO
To configure INFA_REPCNX_INFO on Windows:
X

In a DOS shell, type:

set INFA_REPCNX_INFO = <file name>

Note: If you run multiple pmrep scripts, set this environment variable for the DOS shell, not for the

machine.

Chapter 2: Configuring Environment Variables

INFATOOL_DATEFORMAT
Command Line Program:
pmcmd

Use this environment variable to customize the way pmcmd displays the date and time. Enter the date format
string in DY MON DD HH24:MI:SS YYYY format. pmcmd verifies that the string is a valid format. If the
format string is not valid, the Integration Service generates a warning message and displays the date in the
format DY MON DD HH24:MI:SS YYYY.
To configure INFATOOL_DATEFORMAT on UNIX:
X

In a UNIX C shell environment, type:

setenv INFATOOL_DATEFORMAT <date/time format string>

In a UNIX Bourne shell environment, type:

INFATOOL_DATEFORMAT = <date/time format string>
export INFATOOL_DATEFORMAT
To configure INFATOOL_DATEFORMAT on Windows:
X

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.

Encrypting Passwords
Command Line Programs:
pmcmd
pmrep

You can encrypt passwords to create an environment variable to use with pmcmd and pmrep or to define a
password in a parameter file. For example, you can encrypt the repository and database passwords for pmrep to
maintain security when using pmrep in scripts. Then you can create an environment variable to store the
encrypted password. Or, you can define a password for a relational database connection object in a parameter
file.
Use the command line program pmpasswd to encrypt passwords. The pmpasswd utility uses the following syntax:
pmpasswd <password> [-e (CRYPT_DATA | CRYPT_SYSTEM)]

The following table describes pmpasswd options and arguments:

Option

Argument

Description

n/a

password

Required. The password to encrypt.

-e

CRYPT_DATA,
CRYPT_SYSTEM

Optional. Encryption type:

- CRYPT_DATA. Use to encrypt connection object
passwords that you define in a parameter file.
- CRYPT_SYSTEM. Use for all other passwords.
Default is CRYPT_SYSTEM.

INFATOOL_DATEFORMAT

Using a Password as an Environment Variable

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 password.

pmpasswd generates and displays the encrypted password. For example, if you enter the password monday,
the password encrypts to f/wRb5PZsZnqESTDPeos7Q==.

Configure the password environment variable to set the encrypted value.

To configure a password as an environment variable on UNIX:

At the command line, type:

pmpasswd <password>

pmpasswd returns the encrypted password.

In a UNIX C shell environment, type:

setenv <Password_Environment_Variable> <encrypted password>

In a UNIX Bourne shell environment, type:

<Password_Environment_Variable> = <encrypted password>
export <Password_Environment_Variable>

You can assign the environment variable any valid UNIX name.
To configure a password as an environment variable on Windows:
1.

At the command line, type:

pmpasswd <password>

pmpasswd returns the encrypted password.

Enter the password environment variable in the Variable field. Enter the encrypted password in the Value
field.
For information about setting environment variables on Windows, consult the Windows documentation.

Setting the User Name

Command Line Programs:
pmcmd
pmrep

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

In a UNIX C shell environment, type:

setenv <User_Name_Environment_Variable> <user name>

In a UNIX Bourne shell environment, type:

<User_Name_Environment_Variable> = <user name>
export <User_Name_Environment_Variable>

You can assign the environment variable any valid UNIX name.
To configure a user name as an environment variable on Windows:
X

Enter the user name environment variable in the Variable field. Enter the user name in the Value field.
For information about setting environment variables on Windows, consult the Windows documentation.

Chapter 2: Configuring Environment Variables

CHAPTER 3

infacmd Command Reference

This chapter includes the following topics:

Using infacmd, 11

Syntax and descriptions for the infacmd commands

Using infacmd
infacmd is a command line program that allows you to administer PowerCenter domains, users, 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. List services and the nodes that run them. Update service
processes and service process options. You cannot use infacmd to create services of a previous version.

Domains. Link domains and remove domain links. Change the domain administrator password. Update
domain options. Add and remove service levels.

Users. Create and remove users. Reset user passwords. Subscribe to and unsubscribe users from alerts. Assign
users permission on objects.

Domain gateway. Update the gateway node connectivity information.

Folders. Create, move, list, update, and remove folders. Move objects between folders.

Nodes. Update, ping, shut down, and remove nodes. List node names and options. Add, enable, list, disable,
and remove node resources. Change a node from a gateway node to a worker node or from a worker node to
a gateway node. Calculate the CPU profile for a node.

Grids. Create and remove grids. List nodes in a grid.

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.

For more information about performing infacmd tasks through the user interface, see the PowerCenter
Administrator Guide.

Running Commands
You invoke infacmd from the command line. You can issue commands directly or from a script, batch file, or
other program.
To run infacmd commands:
1.

At the command prompt, switch to the directory where the infacmd executable is located.
By default, infacmd installs in the server\bin directory. You can also install infacmd from the PowerCenter
Installation DVD.

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, 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 example, the following command adds file/directory resource BackupDir to node Node1 in domain
MyDomain on Windows:
infacmd AddNodeResource -dn MyDomain -un AdminUser -pd password -nn Node1 -rt "File
Directory" -rn BkupDir

On UNIX, the same command is as follows:

infacmd.sh AddNodeResource -dn MyDomain -un AdminUser -pd password -nn Node1 -rt "File
Directory" -rn BkupDir

If you omit or incorrectly enter one of the required options, the command fails and infacmd returns an error
message.
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.
Note: If the domain is a mixed-version domain, run infacmd from the installation directory of the latest
PowerCenter version.

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

AddAlertUser
Subscribes a user to alert notification emails. When you subscribe to alerts, you receive domain and service
notification emails for the objects on which you have permission.
12

Chapter 3: infacmd Command Reference

Before you can subscribe any user to alerts, you must configure SMTP settings for the outgoing mail server.
You can run the AddAlertUser command for your user. You can also run the AddAlertUser command for
another user.
The AddAlertUser command uses the following syntax:
AddAlertUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
[<-Password|-pd> password]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-AlertUser|-au> user_name

The following table describes infacmd AddAlertUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date.The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-AlertUser
-au

user_name

Required. Name of user you want to subscribes to alerts.

RELATED TOPICS:
UpdateSMTPOptions on page 161

AddDomainLink
Records connection properties to a remote, or linked, domain so that you can exchange repository metadata
between the local domain and the linked domain. You may want to add a link to a domain if you need to access
a Repository Service in that domain.
You can add a link to another PowerCenter domain when you register or unregister a local repository with a
global repository in another PowerCenter domain.

AddDomainLink

The AddDomainLink command uses the following syntax:

The following table describes infacmd AddDomainLink options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the local domain.

-UserName
-un

user_name

Required. User name used to connect to the local domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the local domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
local domain. If you omit this option, infacmd uses the
timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-LinkedDomainName
-ld

linked_domain_
name

Required. Name of the domain that you want to establish

a connection with.

-DomainLink
-dl

gateway_host1:port
gateway_host2:port
...

Required. The host names and port numbers for the

gateway nodes in the linked domain.

AddDomainNode
Adds a node to a domain. Before you can start the node, you must define it by running the infasetup
DefineGatewayNode or DefineWorkerNode command on the node.
The AddDomainNode command uses the following syntax:
AddDomainNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
14

Chapter 3: infacmd Command Reference

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
[<-FolderPath|-fp> full_folder_path]

The following table describes infacmd AddDomainNode options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node you want to add to the domain.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the

folder in which you want to add the node. Must be in the
following format:
/parent_folder/child_folder
Default is /(the domain).

RELATED TOPICS:
DefineGatewayNode on page 173

DefineWorkerNode on page 175

AddGroupPermission
Assigns a group permission on an object.
Permissions allow a group to access objects in a domain. Objects include the domain, folders, nodes, grids,
licenses, and application services. For example, if you assign a group permission on a folder, the group inherits
permission on all objects in the folder.
The AddGroupPermission command uses the following syntax:
addGroupPermission
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]

AddGroupPermission

[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingGroup|-eg> existing_group_name
<-ObjectFullName|-on> object_full_path_name
[<-ExistingGroupSecurityDomain|-egn> existing_group_security_domain]

The following table describes infacmd AddGroupPermission options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both these methods,
the password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.

Name of the security domain that the user
belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity

information in the domains.infa file is out of
date. The host names and port numbers for the
gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that

infacmd attempts to establish or reestablish a
connection to the domain. If you omit this
option, infacmd uses the timeout value
specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in
the environment variable, the default of 180
seconds is used.

-ExistingGroup
-eg

existing_group_name

Required. Name of the group to which you

want to assign a permission on an object.

-ObjectFullName
-on

object_full_path_name

Required. Full path, excluding the domain

name, to the object. Must be in the following
format:
/parent_folder/child_folder/object_name
To assign a user permission on the domain,
enter a slash (/).

-ExistingGroupSecurityDomain
-egn

existing_group_security
_domain

Required if you use LDAP authentication.

Name of the security domain that the group to
which you want to assign a permission belongs
to. Default is Native.

AddGroupPrivilege
Assigns a privilege to a group in a PowerCenter domain.

Chapter 3: infacmd Command Reference

You can assign privileges to a group for the domain and for each application service in the domain.
The AddGroupPrivilege command uses the following syntax:
addGroupPrivilege
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege

The following table describes infacmd AddGroupPrivilege options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the
timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-GroupName
-gn

group_name

Required. Name of the group to which you are

assigning the privilege. To enter a name that contains a
space or other non-alphanumeric character, enclose
the name in quotation marks.

-GroupSecurityDomain
-gsf

group_security_dom
ain

Required if you use LDAP authentication. Name of the

security domain that the group to which you are
assigning the privilege belongs to. Default is Native.

AddGroupPrivilege

Option

Argument

Description

-ServiceName
-sn

service_name

Required. Domain or application service name for

which you want to view privileges.

-PrivilegePath
-pp

path_of_privilege

Required. Fully-qualified name of the privilege you want

to assign to the group. A fully-qualified name includes
privilege group name and privilege name. For example,
a fully-qualified privilege name for the Repository
Service is folder/create. If the privilege name includes
spaces, enclose the path in quotation marks as follows:
Runtime Objects/Monitor/Execute/Manage Execution.
If the privilege name includes the special character /,
add the escape character \ before it as follows:
Model/View Model/Export\ /Import Models.

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.
The AddLicense command uses the following syntax:
AddLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> securitydomain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
<-LicenseKeyFile|-lf> license_key_file
[<-FolderPath|-fp> full_folder_path]

The following table describes infacmd AddLicense options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the password
set with the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you omit
this option, infacmd uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment variable.
If no value is specified in the environment variable, the default
of 180 seconds is used.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-LicenseName
-ln

license_name

Required. Name of the license. The name is not case sensitive

and must be unique within the domain. The name cannot have
leading or trailing spaces, include carriage returns or tabs,
exceed 79 characters, or contain the following characters:
/*?<>"|

-LicenseKeyFile
-lf

license_key_file

Required. Path to the license key file.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the folder in

which you want to add the license. Must be in the following
format:
/parent_folder/child_folder
Default is /(the domain).

AddNodeResource
Adds a custom or file/directory resource to a node.
When an Integration Service runs on a grid, the Load Balancer can use resources to distribute Session,
Command, and predefined Event-Wait tasks. If the Integration Service is configured to check resources, the
Load Balancer distributes tasks to nodes where the resources are added and enabled.
The AddNodeResource command uses the following syntax:
AddNodeResource
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceType|-rt> resource_type("Custom", "File Directory")
<-ResourceName|-rn> resource_name

The following table describes infacmd AddNodeResource options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

AddNodeResource

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-NodeName
-nn

node_name

Required. Name of the node where you want to add a

resource.

-ResourceType
-rt

resource_type

Required. Type of resource. Valid types include:

- Custom
- File Directory
To specify a file directory resource, enter file directory in
quotation marks.

-ResourceName
-rn

resource_name

Required. Name of the resource. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks. The name cannot
have leading or trailing spaces, include carriage returns or
tabs, exceed 79 characters, or contain the following
characters:
\/*?<>"|$

RELATED TOPICS:
Integration Service Options on page 40

AddRolePrivilege
Assigns a privilege to a role in a PowerCenter domain.
You can assign privileges to a role for the domain and for each application service type in the domain.
The AddRolePrivilege command uses the following syntax:
addRolePrivilege
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> securitydomain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
<-ServiceType|-st> service_type
<-PrivilegePath|-pp> path_of_privilege

The following table describes infacmd AddRolePrivilege options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date.The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-RoleName
-rn

role_name

Required. Name of the role to which you are assigning the

privilege. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

-ServiceType
-st

service_type

Required. Domain or application service type to which you

assign the privilege for the role.
Service types include:
- Domain
- RepositoryService
- MetadataManagerService
- ReportingService
- ReferenceTableManagerService

-PrivilegePath
-pp

path_of_privilege

Required. Fully-qualified name of the privilege you want to

assign to the group. A fully-qualified name includes
privilege group name and privilege name. For example, a
fully-qualified privilege name for the Repository Service is
folder/create. If the privilege name includes spaces,
enclose the path in quotation marks as follows:
Runtime Objects/Monitor/Execute/Manage Execution.
If the privilege name includes the special character /, add
the escape character /before it as follows:
Model/View Model/Export\ /Import Models.

AddServiceLevel
Adds a service level. Service levels establish priority among tasks that are waiting to be dispatched. You can
create different service levels that a task developer can assign to workflows.
Each service level you create has a name, dispatch priority, and maximum dispatch wait time. The dispatch
priority is a number that establishes the priority for dispatch. The Load Balancer dispatches high priority tasks
before low priority tasks. The maximum dispatch wait time specifies the amount of time the Load Balancer
waits before it changes the dispatch priority for a task to the highest priority.
The AddServiceLevel command uses the following syntax:
AddServiceLevel
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
AddServiceLevel

The following table describes infacmd AddServiceLevel options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date.The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceLevelName
-ln

service_level_name

Required. Name of the service level.

-ServiceLevel
-sl

option_name=value

Required. The service level properties. You can set the

following properties:
- DispatchPriority. The initial priority for dispatch. Smaller
numbers have higher priority. Priority 1 is the highest
priority. Default is 5.
- MaxDispatchWaitTime. The amount of time in seconds that
can elapse before the Load Balancer changes the dispatch
priority for a task to the highest priority. Default is 1,800.

AddUserPermission
Assigns a user permission on an object.
Permissions allow a user to access objects in a domain. Objects include the domain, folders, nodes, grids,
licenses, and application services. For example, if you assign a user permission on a folder, the user inherits
permission on all objects in the folder.
The AddUserPermission command uses the following syntax:
AddUserPermission
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]

Chapter 3: infacmd Command Reference

[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
<-ObjectFullName|-on> object_full_path_name
<-ExistingUserSecurityDomain|-esd> existing_user_security_domain

The following table describes infacmd AddUserPermission options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name for the user that assigns

permission.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date.The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-DomainName
-dn

domain_name

Required. Name of the domain.

-ExistingUserName
-eu

existing_user_name

Required. Name of the user to which you want to

assign a permission on an object.

-ObjectFullName
-on

object_full_path_
name

Required. Full path, excluding the domain name, to

the object. Must be in the following format:
/parent_folder/child_folder/object_name
To assign a user permission on the domain, enter a
slash (/).

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user to which you want
to assign a permission belongs to. Default is
Native.

AddUserPrivilege
Assigns a privilege to a user in a PowerCenter domain.
You can assign privileges to a user for the domain and for each application service in the domain.
AddUserPrivilege

The AddUserPrivilege command uses the following syntax:

The following table describes infacmd AddUserPrivilege options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.Name

of the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity

information in the domains.infa file is out of
date. The host names and port numbers for the
gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that

-ExistingUserName
-eu

existing_user_name

Required. User account to which you are

assigning the privilege. To enter a name that
contains a space or other non-alphanumeric
character, enclose the name in quotation
marks.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name

of the security domain that the user to which
you are assigning the privilege belongs to.
Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ServiceName
-sn

service_name

Required. Domain or application service name

for which you want to view privileges.

-PrivilegePath
-pp

path_of_privilege

Required. Fully-qualified name of the privilege

you want to assign to the group. A fully-qualified
name includes privilege group name and
privilege name. For example, a fully-qualified
privilege name for the Repository Service is
folder/create. If the privilege name includes
spaces, enclose the path in quotation marks as
follows:
Runtime Objects/Monitor/Execute/Manage
Execution.
If the privilege name includes the special
character /, add the escape character \
before it as follows:
Model/View Model/Export\ /Import Models.

AddUserToGroup
Adds a native or LDAP user to a native group in a domain. The user inherits all of the permissions and
privileges associated with the group.
The AddUserToGroup command uses the following syntax:
addUserToGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-GroupName|-gn> group_name

The following table describes infacmd AddUserToGroup options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

AddUserToGroup

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host
names and port numbers for the gateway nodes in
the domain.

-ResilienceTimeout
-re

timeout_period_in_se
conds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection
to the domain. If you omit this option, infacmd
uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds
is used.

-ExistingUserName
-eu

existing_user_Name

Required. Name of the user you want to add.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user you want to add
belongs to. Default is Native.

-GroupName
-gn

group_name

Required. Name of the group to which you want to

add the user.

AssignedToLicense
Lists the services assigned to a license. You assign a license to each application service. Use this command to
view the services currently assigned to a license.
The AssignedToLicense command uses the following syntax:
AssignedToLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name

The following table describes infacmd AssignedToLicense options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.Name of the

security domain that the user belongs to. Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-LicenseName
-ln

license_name

Required. Name of the license.

AssignISToMMService
Assigns the associated Integration Service for a Metadata Manager Service.
The AssignISToMMService command uses the following syntax:
AssignISToMMService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> securitydomain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-IntegrationService|-is> integration_service_name
<-RepositoryUser|-ru> repository_user
<-RepositoryPassword|-rp> repository_password

The following table describes infacmd AssignISToMMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

AssignISToMMService

Option

Argument

Description

-ServiceName
-sn

service_name

Required. Name of the Metadata Manager Service to which

you want to assign the Integration Service.

-IntegrationService
-is

integration_service_
name

Required. Name of the Integration Service you want to

associate with the Metadata Manager Service.

-RepositoryUser
-ru

repository_user

Required. Name of the PowerCenter repository user.

-RepositoryPassword
-rp

repository_password

Required. Password for the PowerCenter repository user.

AssignLicense
Assigns a license to an application service. You must assign a license to an application service before you can
enable the service.
Note: You cannot assign a license to a service if the service is assigned to another license. To assign a different
license to a service, use the RemoveLicense command to remove the existing license from the service, and then
assign the new license to the service.

The AssignLicense command uses the following syntax:

The following table describes infacmd AssignLicense options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-LicenseName
-ln

license_name

Required. Name of the license you want to assign to a

service.

-ServiceNames
-sn

service_name1
service_name2 ...

Required. Names of the services for which you want to

assign a license. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks. Restart the service to apply changes.

AssignRoleToGroup
Assigns a role to a group for a domain or application service.
The AssignRoleToGroup command uses the following syntax:
assignRoleToGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name

The following table describes infacmd AssignRoleToGroup options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date.The host names and port
numbers for the gateway nodes in the domain.

AssignRoleToGroup

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-GroupName
-gn

group_name

Required. Name of the group to which you are assigning

the role. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

-GroupSecurityDomain
-gsf

group_security_dom
ain

Required if you use LDAP authentication.Name of the

security domain that the group to which you are
assigning the role belongs to. Default is Native.

-RoleName
-rn

role_name

Required. Name of the role you want to assign to the

group.

-ServiceName
-sn

service_name

Required. Domain or application service name for which

you want to assign the role. To enter a name that
contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

AssignRoleToUser
Assigns a role to a user for a domain or an application service.
The AssignRoleToUser command uses the following syntax:
assignRoleToUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name

The following table describes infacmd AssignRoleToUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date.The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ExistingUserName
-eu

existing_user_Name

Required. User account to which you are assigning

the role. To enter a name that contains a space or
other non-alphanumeric character, enclose the
name in quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication.Name of

the security domain that the user to which you are
assigning the role belongs to. Default is Native.

-RoleName
-rn

role_name

Required. Name of the role you want to assign to

the user.

-ServiceName
-sn

service_name

Required. Domain or application service name for

which you want to assign the role. To enter a name
that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

AssignRSToWSHubService
Associates a repository with a Web Services Hub in a domain.
The AssignRSToWSHubService command uses the following syntax:
AssignRSToWSHubService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name
<-RepositoryUser|-ru> user
<-RepositoryPassword|-rp> password

The following table describes infacmd AssignRSToWSHubService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

AssignRSToWSHubService

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

-ServiceName
-sn

service_name

Required. Name of the Web Services Hub with which

you want to associate a repository.

-NodeName
-nn

node_name

Required. Name of the node where you want the Web

Services Hub process to run. If the PowerCenter
environment is configured for high availability, this
option specifies the name of the primary node.

-RepositoryService
-rs

repository_service_n
ame

Required. Name of the Repository Service that the Web

Services Hub depends on.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryUser
-ru

user

Required. User name used to connect to the repository.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryPassword
-rp

password

Required. User password.

BackupDARepositoryContents
Backs up content for a Data Analyzer repository to a binary file. You can back up the contents of a Data
Analyzer repository to prevent data loss due to hardware or software problems.
When you back up, the Reporting Service saves the Data Analyzer repository to a binary file, including the
repository objects, connection information, and code page information.
Use infacmd RestoreDARepositoryContents to restore the content of the repository from the binary file.
The BackupDARepositoryContents command uses the following syntax:
backupDARepositoryContents
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]

Chapter 3: infacmd Command Reference

[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-fileName|-f> file_name
[<-overwrite|-o> overwrite_file]

The following table describes infacmd BackupDARepositoryContent options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the Reporting Service for which you want

to back up contents.

-fileName
-f

file_name

Required. Name and file path where you want to write the
backup file.

-overwrite
-o

overwrite_file

Overwrites the backup file if a file with the same name already
exists.
Required if a file with the same name exists.

ConvertLogFile
Converts binary log files to text files, XML files, or readable text on the screen.
The ConvertLogFile command uses the following syntax:
ConvertLogFile
<-InputFile|-in> input_file_name
[<-Format|-fm> format_TEXT_XML]
[<-OutputFile|-lo> output_file_name]

ConvertLogFile

The following table describes infacmd ConvertLogFile options and arguments:

Option

Argument

Description

-InputFile
-in

input_file_name

Required. Name and path for the log file you want to convert.
By default, the Service Manager writes log files to the
server\infa_shared\log directory on the master gateway node.

-Format
-fm

format

Optional. Output file format. Valid types include:

- Text
- XML
If you do not specify a format, infacmd uses text format with lines
wrapped at 80 characters.

-OutputFile
-lo

output_file_name

Optional. Name and file path for the output file.

If you do not specify an output file name, infacmd displays the log
events on the screen.

CreateDARepositoryContents
Creates content for a Data Analyzer repository.
Add repository content after you create the Reporting Service or if you deleted the repository content. You
cannot create content for a repository that already includes content.
The CreateDARepositoryContents command uses the following syntax:
CreateDARepositoryContents
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-initialAdmin|-ia> initial_administrator

The following table describes infacmd CreateDARepositoryContents options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the service for which you want to create

content.

-initialAdmin
-ia

initial_administrator

Required. Name of the administrator of the Reporting

Service.

CreateFolder
Creates a folder in the domain. You can use folders to organize objects and to manage security. Folders can
contain nodes, services, grids, licenses, and other folders. When you create a folder, infacmd creates the new
folder in the domain or folder you specify.
The CreateFolder command uses the following syntax:
CreateFolder
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderName|-fn> folder_name
<-FolderPath|-fp> full_folder_path
[<-FolderDescription|-fd> description_of_folder]

The following table describes infacmd CreateFolder options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

CreateFolder

Option

Argument

Description

-FolderName
-fn

folder_name

Required. Name of the folder. Folder names must be unique

within a folder or the domain. It cannot contain spaces or
exceed 79 characters in length.

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, where you

want to create the folder. Must be in the following format:
/parent_folder/child_folder

-FolderDescription
-fd

description_of_folder

Optional. Description of the folder. If the folder description

contains spaces or other non-alphanumeric characters,
enclose it in quotation marks.

CreateGrid
Creates a grid in a domain and assigns nodes to the grid. Create a grid to distribute Session and Command tasks
or Session threads to service processes running on nodes in the grid.
The CreateGrid command uses the following syntax:
CreateGrid
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
<-NodeList|-nl> node1 node2 ...
[<-FolderPath|-fp> full_folder_path]

The following table describes infacmd CreateGrid options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-GridName
-gn

grid_name

Required. Name of the grid.

-NodeList
-nl

node1 node2 ...

Required. Names of the nodes you want to assign to the

grid.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the

folder in which you want to create the grid. Must be in the
following format:
/parent_folder/child_folder
Default is /(the domain).

CreateGroup
Creates a group in the native security domain.
You can assign roles, permissions, and privileges to a group in the native or an LDAP security domain. The
roles, permissions, and privileges assigned to the group determines the tasks that users in the group can perform
within the PowerCenter domain.
The CreateGroup command uses the following syntax:
createGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupDescription|-ds> group_description]

The following table describes infacmd CreateGroup options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

CreateGroup

Option

Argument

Description

-GroupName
-gn

group_name

Required. Name of the group. The group name is not case

sensitive and can be between 1 and 80 characters long. It
cannot include a tab, newline character, or the following
special characters:
,+"\<>;/*%?
The name can include an ASCII space character except for
the first and last character. All other space characters are
not allowed.

-GroupDescription
-ds

group_description

Optional. Description of the group. To enter a description

that contains spaces or other non-alphanumeric characters,
enclose it in quotation marks.
The description cannot include the following special
characters:
<>

CreateIntegrationService
Creates an Integration Service in a domain. By default, the Integration Service is enabled when you create it.
The CreateIntegrationService command uses the following syntax:
CreateIntegrationService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-FolderPath|-fp> full_folder_path]
<-NodeName|-nn> node_name|<-GridName|-gn> grid_name>
[<-BackupNodes|-bn> node1 node2 ...]
<-RepositoryService|-rs> repository_service_name
<-RepositoryUser|-ru> user
<-RepositoryPassword|-rp> password
[<-ServiceDisable|-sd>]
[<-ServiceOptions|-so> option_name=value ...]
[<-ServiceProcessOptions|-po> option_name=value ...]
[<-EnvironmentVariables|-ev> name=value ...]
[<-LicenseName|-ln> license_name]

The following table describes infacmd CreateIntegrationService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both these methods, the password
set with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to. Default
is Native.
To apply changes, restart the Integration Service.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses the
timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ServiceName
-sn

service_name

Required. Name of the Integration Service.

The name is not case sensitive and must be unique
within the domain. The characters must be
compatible with the code page of the associated
repository. The name cannot have leading or trailing
spaces, include carriage returns or tabs, exceed 79
characters, or contain the following characters:
/*?<>"|

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to

the folder in which you want to create the Integration
Service. Must be in the following format:
/parent_folder/child_folder
Default is /(the domain).

-NodeName
-nn

node_name

Required if you do not specify the grid name. Name

of the node where you want the Integration Service
process to run. If the PowerCenter environment is
configured for high availability, this option specifies
the name of the primary node.
To apply changes, restart the Integration Service.

-GridName
-gn

grid_name

Required if you do not specify the node name. Name

of the grid where you want the Integration Service
process to run.
To apply changes, restart the Integration Service.

-BackupNodes
-bn

node1 node2 ...

Optional. If the PowerCenter environment is

configured for high availability, this option specifies
the names of the backup nodes.

-RepositoryService
-rs

repository_service_name

Required. Name of the Repository Service that the

Integration Service depends on.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in
quotation marks.
To apply changes, restart the Integration Service.

-RepositoryUser
-ru

user

Required. User name used to connect to the

repository.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in
quotation marks.
To apply changes, restart the Integration Service.

-RepositoryPassword
-rp

password

Required. User password.

To apply changes, restart the Integration Service.

-ServiceDisable
-sd

n/a

Optional. Creates a disabled service. You must

enable the service before you can run it.

CreateIntegrationService

Option

Argument

Description

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the

Integration Service runs. For more information about
Integration Service options, see Integration Service
Options on page 40.

-ServiceProcessOptions
-po

option_name=value

Optional. Service process properties for the

Integration Service. In a grid or multi-node
environment, infacmd applies these properties to the
primary node, grid, and backup node. For more
information about service process options, see
Integration Service Process Options on page 43.

-EnvironmentVariables
-ev

name=value

Optional. Specify environment variables as

Integration Service process options. You may want
to include additional variables that are unique to
your PowerCenter environment.
To apply changes, restart the node.

-LicenseName
-ln

license_name

Required if you create an enabled service. Name of

the license you want to assign to the Integration
Service.
To apply changes, restart the Integration Service.

Integration Service Options

Enter Integration Service options in the following format:
infacmd CreateIntegrationService ... -so option_name=value option_name=value ...

To enter multiple options, separate them with a space. To enter a value that contains a space or other nonalphanumeric character, enclose the value in quotation marks.
The following table describes Integration Service options:
Option

Description

$PMFailureEmailUser

Optional. Email address of the user to receive email when a session

fails to complete. To enter multiple addresses on Windows, use a
distribution list. To enter multiple addresses on UNIX, separate them
with a comma.

$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).

$PMSessionLogCount

Optional. Number of session logs the Integration Service archives for

the session. Minimum value is 0. Default is 0.

$PMSuccessEmailUser

Optional. Email address of the user to receive email when a session

completes successfully. To enter multiple addresses on Windows, use a
distribution list. To enter multiple addresses on UNIX, separate them
with a comma.

$PMWorkflowLogCount

Optional. Number of workflow logs the Integration Service archives for

the workflow. Minimum value is 0. Default is 0.

AggregateTreatNullAsZero

Optional. Treats nulls as zero in Aggregator transformations. Default is

No.

AggregateTreatRowAsInsert

Optional. Performs aggregate calculations before flagging records for

insert, update, delete, or reject in Update Strategy expressions. Default
is No.

ClientStore

Optional. Enter the value for ClientStore using the following syntax:
<path>/<filename>

For example:
./Certs/client.keystore

Chapter 3: infacmd Command Reference

Option

Description

CreateIndicatorFiles

Optional. Creates indicator files when you run a workflow with a flat file
target. Default is No.

DataMovementMode

Optional. Mode that determines how the Integration Service handles

character data:
- ASCII
- Unicode
Default is ASCII.

DateDisplayFormat

Optional. Date format the Integration Service uses in log entries.

Default is DY MON DD HH 24:MI:SS YYYY.

DateHandling40Compatibility

Optional. Handles dates as in PowerCenter 1.0/PowerMart 4.0. Default

is No.

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).

ErrorSeverityLevel

Optional. Minimum level of error logging for the Integration Service logs:
- Fatal
- Error
- Warning
- Info
- Trace
- Debug
Default is Info.

ExportSessionLogLibName

Optional. Name of an external library file to write session log messages.

FlushGMDWrite

Required if you enable session recovery. Flushes session recovery data

for the recovery file from the operating system buffer to the disk. Specify
one of the following levels:
- Auto. Flushes recovery data for all real-time sessions with a JMS or
WebSphere MQ source and a non-relational target.
- Yes. Flushes recovery data for all sessions.
- No. Does not flush recovery data. Select this option if you have highly
available external systems or if you need to optimize performance.
Default is Auto.

HttpProxyDomain

Optional. Domain for authentication.

HttpProxyPassword

Required if the proxy server requires authentication. Password for the

authenticated user.

HttpProxyPort

Optional. Port number of the HTTP proxy server.

HttpProxyServer

Optional. Name of the HTTP proxy server.

HttpProxyUser

Required if the proxy server requires authentication. Authenticated user

name for the HTTP proxy server.

IgnoreResourceRequirements

Optional. Ignores task resource requirements when distributing tasks

across the nodes of a grid. Default is Yes.

JCEProvider

Optional. JCEProvider class name to support NTLM authentication.

For example:
com.unix.crypto.provider.UnixJCE.

JoinerSourceOrder6xCompatibility

Optional. Processes master and detail pipelines sequentially as in

PowerCenter versions prior to 7.0. Default is No.

LoadManagerAllowDebugging

Optional. Allows you to use this Integration Service to run debugger

sessions from the Designer. Default is Yes.

LogsInUTF8

Optional. Writes all logs using the UTF-8 character set. Default is Yes
(Unicode) or No (ASCII).

MSExchangeProfile

Optional. Microsoft Exchange profile used by the Service Start Account

to send post-session email.

CreateIntegrationService

Option

Description

MaxLookupSPDBConnections

Optional. Maximum number of connections to a lookup or stored

procedure database when you start a session. Minimum value is 0.
Default is 0.

MaxMSSQLConnections

Optional. Maximum number of connections to a Microsoft SQL Server

database when you start a session. Minimum value is 100. Maximum
value is 2,147,483,647. Default is 100.

MaxResilienceTimeout

Optional. Maximum amount of time in seconds that the service holds on

to resources for resilience purposes. Default is 180.

MaxSybaseConnections

Optional. Maximum number of connections to a Sybase database when

you start a session. Minimum value is 100. Maximum value is
2,147,483,647. Default is 100.

NumOfDeadlockRetries

Optional. Number of times the Integration Service retries writing to a

target on a database deadlock. Minimum value is 0. Maximum value is
2,147,483,647. Default is 10.

OperatingMode

Optional. Operating mode for the Integration Service:

- Normal
- Safe
Default is Normal.

OperatingModeOnFailover

Optional. Operating mode for the Integration Service when the service
process fails over:
- Normal
- Safe
Default is Normal.

OutputMetaDataForFF

Optional. Writes column headers to flat file targets. Default is No.

PersistentRuntimeStatsToRepo

Optional. Level of run-time information stored in the repository. Specify

one of the following levels:
- None. Integration Service does not store any session or workflow runtime information in the repository.
- Normal. Integration Service stores workflow details, task details,
session statistics, and source and target statistics in the repository.
- Verbose. Integration Service stores workflow details, task details,
session statistics, source and target statistics, partition details, and
performance details in the repository.
Default is Normal.

Pmserver3XCompatibility

Optional. Handles Aggregator transformations as the PowerMart Server

did in PowerMart 3.5. Default is No.

RunImpactedSessions

Optional. Runs sessions that are impacted by dependency updates.

Default is No.

ServiceResilienceTimeout

Optional. Amount of time in seconds that the service tries to establish or

reestablish a connection to another service. Default is 180.

TimeStampLog

Optional. Appends a timestamp to messages written to the workflow

log. Default is No.

TimestampWorkflowLogMessages

Optional. Appends a timestamp to messages written to the workflow

log. Default is No.

TreatCharAsCharOnRead

Optional. Keeps trailing spaces when reading SAP or PeopleSoft CHAR

data. Default is Yes.

TreatDBPartitionAsPassThrough

Optional. Uses pass-through partitioning for non-DB2 targets when the

partition type is Database Partitioning. Default is No.

TreatNullInComparisonOperators
As

Optional. Determines how the Integration Service evaluates null values

in comparison operations:
- Null
- Low
- High
Default is Null.

Chapter 3: infacmd Command Reference

Option
TrustStore

Description
Optional. Enter the value for TrustStore using the following syntax:
<path>/<filename>

For example:
./Certs/trust.keystore

UseOperatingSystemProfiles

Optional. Enables use of operating system profiles. Use this option if

the Integration Service runs on UNIX.

ValidateDataCodePages

Optional. Enforces data code page compatibility. Default is Yes.

WriterWaitTimeOut

Optional. In target-based commit mode, the amount of time in seconds

the writer remains idle before it issues a commit. Minimum value is 60.
Maximum value is 2,147,483,647. Default is 60.

XMLWarnDupRows

Optional. Writes duplicate row warnings and duplicate rows for XML
targets to the session log. Default is Yes.

Integration Service Process Options

Enter service process options in the following format:
infacmd CreateIntegrationService ... -po option_name=value option_name=value ...

Description

$PMBadFileDir

Optional. Default directory for reject files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/BadFiles.

$PMCacheDir

Optional. Default directory for index and data cache files. It cannot include the
following special characters:
*?<>"|,
Default is $PMRootDir/Cache.

$PMExtProcDir

Optional. Default directory for external procedures. It cannot include the

following special characters:
*?<>"|,
Default is $PMRootDir/ExtProc.

$PMLookupFileDir

Optional. Default directory for lookup files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/LkpFiles.

$PMRootDir

Optional. Root directory accessible by the node. It cannot include the following
special characters:
*?<>"|,
Default is C:\Informatica\PowerCenter8.6\server\infa_shared.

$PMSessionLogDir

Optional. Default directory for session logs. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/SessLogs.

$PMSourceFileDir

Optional. Default directory for source files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/SrcFiles.

$PMStorageDir

Optional. Default directory for run-time files. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/Storage.

CreateIntegrationService

Option

Description

$PMTargetFileDir

Optional. Default directory for target files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/TgtFiles.

$PMTempDir

Optional. Default directory for temporary files. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/Temp.

$PMWorkflowLogDir

Optional. Default directory for workflow logs. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/WorkflowLogs.

Codepage_ID

Required. Code page ID number for the Integration Service process.

JVMClassPath

Optional. Java SDK classpath.

JVMMaxMemory

Optional. Maximum amount of memory the Java SDK uses during a

PowerCenter session. Default is 64 MB.

JVMMinMemory

Optional. Minimum amount of memory the Java SDK uses during a PowerCenter
session. Default is 32 MB.

CreateMMService
Creates a Metadata Manager Service in a domain. By default, the Metadata Manager Service is disabled when
you create it.
The CreateMMService command uses the following syntax:
CreateMMService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-ServiceOptions|-so> option_name=value ...>
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]

The following table describes infacmd CreateMMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to.Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the Metadata Manager Service.

The name is not case sensitive and must be unique within
the domain. The name cannot have contain spaces,
include carriage returns or tabs, exceed 79 characters, or
contain the following characters:
/*?<>"|

-NodeName
-nn

node_name

Required. Name of the node where you want the Metadata

Manager application to run.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the Metadata

Manager Service runs. For more information about
Metadata Manager Service options, see Metadata
Manager Service Options on page 45.

-LicenseName
-ln

license_name

Required. Name of the license you want to assign to the

Metadata Manager Service.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the

folder in which you want to create the Metadata Manager
Service. Must be in the following format:
/parent_folder/child_folder
Default is /(the domain).

Metadata Manager Service Options

Enter Metadata Manager Service options in the following format:
infacmd CreateMMService ... -so option_name=value option_name=value ...

Description

AgentPort

Required. Port number for the Metadata Manager Agent. The agent uses
this port to communicate with metadata source repositories. Default is
10251.

CodePage

Required. Code page description for the Metadata Manager repository. To

enter a code page description that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

ConnectString

Required. Native connect string for the Metadata Manager repository

database.

DBUser

Required. User account for the Metadata Manager repository database.

DBPassword

Required. Password for the Metadata Manager repository database user.

DatabaseHostname

Required. Host name for the Metadata Manager repository database.

CreateMMService

Option

Description

DatabaseName

Required. Full service name or SID for Oracle databases. Service name for
IBM DB2 databases. Database name for Microsoft SQL Server or Sybase
ASE databases.

DatabasePort

Required. Port number for the Metadata Manager repository database.

DatabaseType

Required. Type of database for the Metadata Manager repository.

ErrorSeverityLevel

Optional. Level of error messages written to the Metadata Manager

Service log.
Default is ERROR.

FileLocation

Required. Location of the files used by the Metadata Manager application.

JdbcOptions

Optional. Additional JDBC options.

MaxConcurrentRequests

Optional. Maximum number of request processing threads available, which

determines the maximum number of client requests that Metadata
Manager can handle simultaneously.
Default is 100.

MaxHeapSize

Optional. Amount of RAM in megabytes allocated to the Java Virtual

Manager (JVM) that runs Metadata Manager.
Default is 512.

MaxQueueLength

Optional. Maximum queue length for incoming connection requests when

all possible request processing threads are in use by the Metadata
Manager application.
Default is 500.

MaximumActiveConnections

Optional. Number of active connections to the Metadata Manager

repository database available. The Metadata Manager application
maintains a connection pool for connections to the repository database.
Default is 20.

MaximumWaitTime

Optional. Amount of time in seconds that Metadata Manager holds

database connection requests in the connection pool.
Default is 180.

MetadataTreeMaxFolderChilds

Optional. Number of child objects that appear in the Metadata Manager

metadata catalog for any parent object.
Default is 100.

ODBCConnectionMode

Connection mode the Integration Service uses to connect to metadata

sources and the Metadata Manager repository when loading resources.
Value can be true or false.
You must set this property to True if the Integration Service runs on a UNIX
machine and you want to load metadata from a Microsoft SQL Server
database or if you use a Microsoft SQL Server database for the Metadata
Manager repository.

OracleConnType

Required if you select Oracle for the DatabaseType. Oracle connection

type. You can enter one of the following options:
- OracleSID
- OracleServiceName

PortNumber

Required. Port number the Metadata Manager application runs on. Default
is 10250.

StagePoolSize

Optional. Maximum number of resources that Metadata Manager can load

simultaneously.
Default is 3.

TablespaceName

Tablespace name for the Metadata Manager repository on IBM DB2.

TimeoutInterval

Optional. Amount of time in minutes that Metadata Manager holds a failed

resource load in the load queue.
Default is 30.

Chapter 3: infacmd Command Reference

Option

Description

URLScheme

Required. Indicates the security protocol that you configure for the
Metadata Manager application: HTTP or HTTPS

keystoreFile

Required if you use HTTPS. Keystore file that contains the keys and
certificates required if you use the SSL security protocol with the Metadata
Manager application.

CreateOSProfile
Creates an operating system profile in a domain.
Before you run workflows that use operating system profiles, you must configure the Integration Service to use
operating system profiles.
The CreateOSProfile command uses the following syntax:
createOSProfile
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name
<-SystemName|-sn> system_username
[<-IntegrationServiceProcessOptions|-po> option_name=value ...
[<-EnvironmentVariables|-ev> name=value ...]

The following table describes infacmd CreateOSProfile options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods,
the password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name

of the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:
port
gateway_host2:
port ...

Required if the gateway connectivity information

in the domains.infa file is out of date. The host
names and port numbers for the gateway nodes in
the domain.

CreateOSProfile

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_
in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection
to the domain. If you omit this option, infacmd
uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in
the environment variable, the default of 180
seconds is used.

-OSProfileName
-on

OSProfile_name

Required. Name of the operating system profile.

The operating system profile name can be up to
80 characters. It cannot include spaces or the
following special characters: \ / : * ? " < > | [ ] = + ;
,

-SystemName
-sn

system_userna
me

Required. Name of an operating system user that

exists on the machines where the Integration
Service runs. The Integration Service runs
workflows using the system access of the system
user defined for the operating system profile.

-IntegrationServiceProcessOptions
-po

option_name=va
lue

Optional. Service process properties that define

how the Integration Service runs. For more
information about Integration Service options, see
Integration Service Process Options for
Operating System Profiles on page 48.

-EnvironmentVariables
-ev

name=value

Optional. Name and value of environment

variables used by the Integration Service at run
time.

Integration Service Process Options for Operating System Profiles

Enter Integration Service process options in the following format:
infacmd CreateOSProfile ... -po option_name=value option_name=value ...

Option

Description

$PMBadFileDir

Optional. Directory for reject files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/BadFiles.

$PMCacheDir

Optional. Directory for index and data cache files. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/Cache.

$PMExtProcDir

Optional. Directory for external procedures. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/ExtProc.

$PMLookupFileDir

Optional. Directory for lookup files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/LkpFiles.

$PMRootDir

Optional. Root directory accessible by the node. It cannot include the following
special characters:
*?<>"|,
Default is C:\Informatica\PowerCenter\server\infa_shared.

Chapter 3: infacmd Command Reference

Option

Description

$PMSessionLogDir

Optional. Directory for session logs. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/SessLogs.

$PMSourceFileDir

Optional. Directory for source files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/SrcFiles.

$PMStorageDir

Optional. Directory for run-time files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/Storage.

$PMTargetFileDir

Optional. Directory for target files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/TgtFiles.

$PMTempDir

Optional. Directory for temporary files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/Temp.

CreateReportingService
Creates a Reporting Service in a PowerCenter domain.
Use infacmd EnableService to enable the Reporting Service.
The CreateReportingService command uses the following syntax:
createReportingService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-LicenseName|-ln> license_name
[<-FolderPath|-fp> full_folder_path]
<-ServiceOptions|-so> option_name=value ...
<-ReportingSource|-rs> option_name=value ...
[<-LineageService|-ls> option_name=value ...]

The following table describes infacmd CreateReportingService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

CreateReportingService

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password
set with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to. Default
is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses the
timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ServiceName
-sn

service_name

Required. Name of the Reporting Service.

The name is not case sensitive and must be unique
within the domain. The name cannot have leading or
trailing spaces, include carriage returns or tabs,
exceed 79 characters, or contain the following
characters:
/*?<>"|

-NodeName
-nn

node_name

Required. Name of the node where you want the

Reporting Service process to run.

-LicenseName
-ln

license_name

Required. Name of the license you want to assign to

the ReportingService.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to

the folder in which you want to create the Reporting
Service. Must be in the following format:
/parent_folder/child_folder
Default is /(the domain).

-ServiceOptions
-so

option_name=value

Required. Service properties that define how the

Reporting Service runs. For more information about
Reporting Service options, see Reporting Service
Options on page 50.

-ReportingSource
-rs

option_name=value

Required. Specify the name and type of the data

source.
For more information about Reporting Source
options, see Reporting Source Options on page 52.

-LineageService
-ls

option_name=value

Optional. Lineage properties required to perform

lineage analysis for data in Data Analyzer. For more
information about Lineage Service options, see
Lineage Service Options on page 52.

Reporting Service Options

Enter Reporting Service options in the following format:
infacmd CreateReportingService ... -so option_name=value option_name=value ...

Chapter 3: infacmd Command Reference

Description

AdditionalJdbcParams

Optional. Enter additional JDBC options. Use this option to specify

character encoding or the location of a server if you are using a database
server that is highly available such as Oracle RAC.

DatabaseDriver

Required. JDBC driver that the Reporting Service uses to connect to the
Data Analyzer repository database.

DatabaseHost

Required. Name of the machine that hosts the database server.

DatabaseName

Required. Full service name or SID for Oracle databases. Service name
for IBM DB2 databases. Database name for Microsoft SQL Server or
Sybase ASE databases. Use DatabaseNameInterpretation option to
specify whether the DatabaseName option contains a service name, SID,
or database name.

DatabaseNameInterpretation

Required if the DatabaseName option contains a full Oracle service

name. Type of DatabaseName option. You can use the following values:
- DatabaseName. The DatabaseName option contains a database name
for Microsoft SQL Server or Sybase ASE databases, or a service name
for IBM DB2 databases.
- OracleSID. The DatabaseName option contains an Oracle SID.
- OracleServiceName. The DatabaseName option contains a full Oracle
service name.
By default, infacmd uses DatabaseName for all non-Oracle databases.

DatabasePassword

Required. Data Analyzer repository database password corresponding to

the database user.

DatabasePort

Required. Port number for the repository database.

DatabaseTablespaceName

Required if you choose an IBM DB2 database. Tablespace name for IBM
DB2 repositories. When you specify the tablespace name, the Reporting
Service creates all repository tables in the same tablespace.

DatabaseUser

Required. User account for the repository database.

DatasourceDriver

Optional. The driver that the Reporting Service uses to connect to the
data source.

DatasourcePassword

Required. Password corresponding to the data source user.

DatasourceTestTable

Required. Test table that the Reporting Service uses to verify the
connection to the data source.

DatasourceURL

Required. JDBC connection string that the Reporting Service uses to

connect to the data source.

DatasourceUser

Required. User account for the data source database.

HttpPort

Required if you do not use the SslPort option. TCP port that the
Reporting Service uses.

SslPort

Required if you do not use the HttpPort option. SSL port that the
Reporting Service uses for secure connections.

DataSourceAdvancedMode

Edit mode that determines where you can edit Datasource properties.
When enabled, the edit mode is advanced, and the value is true. In
advanced edit mode, you can edit Datasource and Dataconnector
properties in the Data Analyzer instance.
When disabled, the edit mode is basic, and the value is false. In basic
edit mode, you can edit Datasource properties in the Administration
Console.
Note: After you enable the Reporting Service in advanced edit mode,
you cannot change it back to basic edit mode.

CreateReportingService

Reporting Source Options

Enter Reporting source options in the following format:
infacmd CreateReportingService ... -rs option_name=value option_name=value

Description

DatasourceName

Required. Name of the service for reporting.

DatasourceType

Required. Type of service. Service types include:

- Dataprofiling
- MM
- PCRR
- Other

Lineage Service Options

Enter lineage service options in the following format:
infacmd CreateReportingService ... -ls option_name=value option_name=value

Description

MetadataManagerService

Optional. Name of the Metadata Manager Service to which you want to connect to
perform data lineage.

ResourceName

Optional. Name of the resource in the Metadata Manager for which you loaded
the Data Analyzer metadata.

CreateRepositoryService
Creates a Repository Service in a domain. By default, the Repository Service is enabled when you create it.
A Repository Service manages one repository. It performs all metadata transactions between the repository and
repository clients.
The CreateRepositoryService command uses the following syntax:
CreateRepositoryService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-BackupNodes|-bn> node1 node2 ...]
[<-ServiceDisable|-sd>]
<-ServiceOptions|-so> option_name=value ...
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]

Chapter 3: infacmd Command Reference

The following table describes infacmd CreateRepositoryService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the Repository Service. The name is not

case sensitive and must be unique within the domain. The
characters must be compatible with the code page of the
associated repository. The name cannot have leading or
trailing spaces, include carriage returns or tabs, exceed 79
characters, or contain the following characters:
\/:*?<>"|

-NodeName
-nn

node_name

Required. Name of the node where you want the Repository

Service process to run. If the PowerCenter environment is
configured for high availability, this option specifies the name
of the primary node.

-BackupNodes
-bn

node1 node2 ...

Optional. If the PowerCenter environment is configured for

high availability, this option specifies the names of the backup
nodes.

-ServiceDisable
-sd

n/a

Optional. Creates a disabled service. You must enable the

service before you can run it.

-ServiceOptions
-so

option_name=value

Required. Service properties that define how the Repository

Service runs. For more information about Repository Service
options, see Repository Service Options on page 53.

-LicenseName
-ln

license_name

Required if you create an enabled service. Name of the

license you want to assign to the Repository Service.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the folder

in which you want to create the Repository Service. Must be in
the following format:
/parent_folder/child_folder
Default is /(the domain).

Repository Service Options

Enter Repository Service options in the following format:
infacmd CreateRepositoryService ... -so option_name=value option_name=value ...

CreateRepositoryService

Option

Description

AllowWritesWithRACaching

Optional. Uses PowerCenter Client tools to modify metadata in the repository

when repagent caching is enabled. Default is Yes.

CheckinCommentsRequired

Optional. Requires users to add comments when checking in repository

objects. Default is Yes. To apply changes, restart the Repository Service.

CodePage

Required. Code page description for the database. To enter a code page
description that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

ConnectString

Required. Database connection string specified during Repository Service

setup. To apply changes, restart the Repository Service.

DBPassword

Required. Repository database password corresponding to the database

user. To apply changes, restart the Repository Service.

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.

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).

DBUser

Required. Account for the database containing the repository. To apply

changes, restart the Repository Service.

DatabaseArrayOperationSize

Optional. Number of rows to fetch each time an array database operation is

issued, such as insert or fetch. Default is 100. To apply changes, restart the
Repository Service.

DatabaseConnectionTimeout

Optional. Amount of time in seconds that the Repository Service attempts to

establish a connection to the database management system. Default is 180.

DatabasePoolSize

Optional. Maximum number of connections to the repository database that

the Repository Service can establish. Minimum is 20. Default is 500.

DatabaseType

Required. Type of database that stores the repository metadata. To apply

changes, restart the Repository Service.

EnableRepAgentCaching

Optional. Enables the repository agent caching feature. Default is Yes.

ErrorSeverityLevel

Optional. Minimum level of error messages written to the Repository Service

log:
- Fatal
- Error
- Warning
- Info
- Trace
- Debug
Default is Info.

HeartBeatInterval

Optional. Interval at which the Repository Service verifies its connections

with clients of the service. Default is 60 seconds.

MaxResilienceTimeout

Optional. Maximum amount of time in seconds that the service holds on to

resources for resilience purposes. Default is 180.

MaximumConnections

Optional. Maximum number of connections the repository accepts from

repository clients. Default is 200.

MaximumLocks

Optional. Maximum number of locks the repository places on metadata

objects. Default is 50,000.

Chapter 3: infacmd Command Reference

Option

Description

OperatingMode

Optional. Mode in which the Repository Service is running:

- Normal
- Exclusive
Default is Normal. To apply changes, restart the Repository Service.

PreserveMXData

Optional. Preserves MX data for prior versions of mappings. Default is

disabled.

RACacheCapacity

Optional. Number of objects that the cache can contain when repository
agent caching is enabled. Default is 10,000.

SecurityAuditTrail

Optional. Tracks changes made to users, groups, privileges, and

permissions. Default is No.

ServiceResilienceTimeout

Optional. Amount of time in seconds that the service tries to establish or

reestablish a connection to another service. Default is 180. To apply changes,
restart the Repository Service.

TableOwnerName

Optional. Name of the owner of the repository tables for an IBM DB2
repository.

TablespaceName

Optional. Tablespace name for IBM DB2 repositories. To apply changes,

restart the Repository Service.

TrustedConnection

Optional. Uses Windows authentication to access the Microsoft SQL Server

database. Default is No. To apply changes, restart the Repository Service.

CreateRole
Creates a custom role in a domain.
You can then assign privileges to the role for the domain or for an application service type. You cannot create
system-defined roles.
The CreateRole command uses the following syntax:
createRole
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> securitydomain]
[<-Password|-pd> password]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
[<-RoleDescription|-rd> role_description]

The following table describes infacmd CreateRole options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

CreateRole

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-RoleName
-rn

role_name

Required. Name of the role. The role name is case

insensitive and can be between 1 and 80 characters long. It
cannot include a tab, newline character, or the following
special characters:
,+"\<>;/*%?
The name can include an ASCII space character except for
the first and last character. All other space characters are
not allowed.

-RoleDescription
-rd>

role_description

Optional. Description of the role. The description can have a

maximum of 1,000 characters and cannot include a tab,
newline character, or the following special characters:
<>"
To enter a description that contains spaces or other nonalphanumeric characters, enclose it in quotation marks.

CreateRTMService
Creates a Reference Table Manager Service in a domain. By default, the Reference Table Manager Service is
disabled when you create it.
The CreateRTMService command uses the following syntax:
createRTMService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-ServiceOptions|-so> option_name=value
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]

The following table describes infacmd CreateRTMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Required. Name of the Reference Table Manager Service.

The name is not case sensitive and must be unique within
the domain. The name cannot have contain spaces, include
carriage returns or tabs, exceed 79 characters, or contain
the following characters:
/*?<>"|

-NodeName
-nn

node_name

Required. Name of the node where you want the Reference

Table Manager application to run.

-ServiceOptions
-so

option_name=value

Required. Service properties that define how the Reference

Table Manager Service runs. For more information about
Reference Table Manager Service options, see Reference
Table Manager Service Options on page 57.

-LicenseName
-ln

license_name

Optional. Name of the license you want to assign to the

Reference Table Manager Service.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the

folder in which you want to create the Reference Table
Manager Service. Must be in the following format:
/parent_folder/child_folder
Default is /(the domain).

Reference Table Manager Service Options

Enter Reference Table Manager Service options in the following format:
infacmd CreateRTMService ... -so option_name=value option_name=value ...

Description

DBUser

Required. User account for the Reference Table Manager repository

database.

DBPassword

Required. Password for the Reference Table Manager repository database

user.

DatabaseHostname

Required. Host name for the Reference Table Manager repository database.

CreateRTMService

Option

Description

DatabaseName

Required. The service name for IBM DB2, the database name for Microsoft
SQL Server, or the SID for Oracle.

DatabasePort

Required. Port number for the Reference Table Manager repository

database.

Database Type

Required. Type of database for the Reference Table Manager repository.

ErrorSeverityLevel

Optional. Level of error messages written to the Reference Table Manager

Service log.
Default is ERROR.

JdbcOptions

Optional. Additional JDBC options. Use this option to specify character

encoding or the location of a backup server if you are using a database
server that is highly available such as Oracle RAC.

MaxConcurrentRequests

Optional. Maximum number of request processing threads available, which

determines the maximum number of client requests that Reference Table
Manager can handle simultaneously.
Default is 100.

MaxHeapSize

Optional. Amount of RAM in megabytes allocated to the Java Virtual

Manager (JVM) that runs Reference Table Manager.
Default is 512.

MaxQueueLength

Optional. Maximum queue length for incoming connection requests when all
possible request processing threads are in use by the Reference Table
Manager application.
Default is 500.

MaximumActiveConnections

Optional. Maximum number of active connections available to the

Reference Table Manager repository database. The Reference Table
Manager application maintains a connection pool for connections to the
repository database.
Default is 20.

MaximumWaitTime

Optional. Amount of time in seconds that Reference Table Manager holds

database connection requests in the connection pool.
Default is 180.

PortNumber

Required. Port number the Reference Table Manager application runs on.
Default is 10260.

TablespaceName

Required if you choose an IBM DB2 database. Tablespace name for the
Reference Table Manager repository on IBM DB2.

URLScheme

Required. Indicates the security protocol that you configure for the
Reference Table Manager application: HTTP or HTTPS

keystoreFile

Required if you use HTTPS. Keystore file that contains the keys and
certificates required if you use the SSL security protocol with the Reference
Table Manager application.

CreateSAPBWService
Creates an SAP BW Service in a domain. By default, the SAP BW Service is enabled when you create it.
The CreateSAPBWService command uses the following syntax:
CreateSAPBWService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

Chapter 3: infacmd Command Reference

The following table describes infacmd CreateSAPBWService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ServiceName
-sn

service_name

Required. Name of the SAP BW Service.

The name is not case sensitive and must be unique
within the domain. The characters must be
compatible with the code page of the associated
repository. The name cannot have leading or
trailing spaces, include carriage returns or tabs,
exceed 79 characters, or contain the following
characters:
/*?<>"|

-NodeName
-nn

node_name

Required. Name of the node where you want the

SAP BW Service process to run. If the
PowerCenter environment is configured for high
availability, this option specifies the name of the
primary node.

-IntegrationService
-is

integration_service_
name

Required. Name of the Integration Service to which

the SAP BW Service connects.
To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

CreateSAPBWService

Option

Argument

Description

-RepositoryUser
-ru

user

Required. User name used to connect to the

repository.
To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

-RepositoryPassword
-rp

password

Required. User password.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the

SAP BW Service runs. For more information, see
Integration Service Options on page 40.

-ServiceProcessOptions
-po

option_name=value

Optional. Service process properties for the SAP

BW Service. For more information about service
process options, see SAP BW Service Process
Option on page 60.

-ServiceDisable
-sd

n/a

Optional. Creates a disabled service. You must

enable the service before you can run it.

-LicenseName
-ln

license_name

Required if you create an enabled service. Name

of the license you want to assign to the SAP BW
Service.

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to

the folder in which you want to create the SAP BW
Service. Must be in the following format:
/parent_folder/child_folder
Default is /(the domain).

SAP BW Service Options

Enter SAP BW Service options in the following format:
infacmd CreateSAPBWService ... -so option_name=value option_name=value ...

Description

BWSystemConxString

Optional. Type R DEST entry in the saprfc.ini file created for the SAP BW
Service. Edit this property if you have created a different type R DEST
entry in sapfrc.ini for the SAP BW Service.

RetryPeriod

Optional. Number of seconds the SAP BW Service waits before trying to

connect to the BW system if a previous connection attempt failed.
Default is 5.

SAP BW Service Process Option

Enter the service process option in the following format:
infacmd CreateSAPBWService ... -po option_name=value

To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation
marks.
The following table describes the SAP BW Service process option:

Option

Description

ParamFileDir

Optional. Temporary parameter file directory. Default is $PMRootDir\BWParam.

Chapter 3: infacmd Command Reference

CreateUser
Creates a user account in the native security domain.
You can then assign roles, permissions, and privileges to a user account. The roles, permissions, and privileges
assigned to the user determine the tasks the user can perform within the PowerCenter domain.
The CreateUser command uses the following syntax:
createUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NewUserName|-nu> new_user_name
<-NewUserPassword|-np> new_user_password
[<-NewUserFullName|-nf> new_user_full_name]
[<-NewUserDescription|-ds> new_user_description]
[<-NewUserEMailAddress|-em> new_user_email_address]
[<-NewUserPhoneNumber|-pn> new_user_phone_number]

The following table describes infacmd CreateUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name for the user that creates the new
user.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-NewUserName
-nu

new_user_name

Required. Login name for the user account. The login

name for a user account must be unique within the
security domain to which it belongs.
The login name is not case sensitive and can be between
1 and 80 characters long. It cannot include a tab, newline
character, or the following special characters:
,+"\<>;/*%?
The name can include an ASCII space character except
for the first and last character. All other space characters
are not allowed.

CreateUser

Option

Argument

Description

-NewUserPassword
-np

new_user_password

Required. Password for the user account. The password

is case-sensitive and can be between 1 and 80
characters long.

-NewUserFullName
-nf

new_user_full_name

Optional. Full name for the user account. To enter a name

that contains spaces or other non-alphanumeric
characters, enclose the name in quotation marks. The full
name cannot include the following special characters:
<>

-NewUserDescription
-ds

new_user_
description

Optional. Description of the user account. To enter a

description that contains spaces or other nonalphanumeric characters, enclose it in quotation marks.
The description cannot include the following special
characters:
<>

-NewUserEMailAddress
-em

new_user_email_
address

Optional. Email address for the user. To enter an address

that contains spaces or other non-alphanumeric
characters, enclose it in quotation marks.
The email address cannot include the following special
characters:
<>
Enter the email address in the format
UserName@Domain.

-NewUserPhoneNumber
-pn

new_user_phone_
number

Optional. Telephone number for the user. To enter a

telephone number that contains spaces or other nonalphanumeric characters, enclose it in quotation marks.
The telephone number cannot include the following
special characters:
<>

CreateWSHubService
Creates a Web Services Hub in a domain. By default, the Web Services Hub is enabled when you create it.
The CreateWSHubService command uses the following syntax:
CreateWSHubService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-FolderPath|-fp> full_folder_path]
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name
<-RepositoryUser|-ru> user
<-RepositoryPassword|-rp> password
[<-ServiceDisable|-sd>]
[<-ServiceOptions|-so> option_name=value ...
<-LicenseName|-ln> license_name

Chapter 3: infacmd Command Reference

The following table describes infacmd CreateWSHubService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Name of the Web Services Hub you want to create.

The name is not case sensitive and must be unique within
the domain. The characters must be compatible with the
code page of the associated repository. The name cannot
have leading or trailing spaces, include carriage returns or
tabs, exceed 79 characters, or contain the following
characters:
/*?<>"|

-FolderPath
-fp

full_folder_path

Optional. Full path, excluding the domain name, to the folder

in which you want to create the Web Services Hub. Must be
in the following format:
/parent_folder/child_folder
Default is /(the domain).

-NodeName
-nn

node_name

Required. Name of the node where you want to run the Web
Services Hub process.

-RepositoryService
-rs

repository_service_
name

Required. Name of the Repository Service that the Web

Services Hub depends on.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryUser
-ru

user

Required. User name used to connect to the repository.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryPassword
-rp

password

Required. User password.

-ServiceDisable
-sd

n/a

Optional. Creates a disabled service. You must enable the

service before you can run it.

CreateWSHubService

Option

Argument

Description

-ServiceOptions
-so

option_name=value
...

Optional. Service properties that define how the Web

Services Hub runs. For more information about Web
Services Hub options, see Web Services Hub Options on
page 64.

-LicenseName
-ln

license_name

Required. Name of the license you want to assign to the

Web Services Hub.

Web Services Hub Options

Enter Web Services Hub options in the following format:
infacmd CreateWSHubService ... -so option_name=value option_name=value ...

Option

Description

DTMTimeout

Optional. Amount of time in seconds that infacmd attempts to establish or

reestablish a connection to the DTM. Default is 60.

ErrorSeverityLevel

Optional. Minimum level of error logging for the Web Services Hub logs:
- Fatal
- Error
- Warning
- Info
- Trace
- Debug
Default is Info.

HubHostName

Optional. Name of the machine hosting the Web Services Hub. Default is
localhost. To apply changes, restart the Web Services Hub.

HubPortNumber

Optional. Port number on which the Web Services Hub runs in Tomcat.
Default is 7333. To apply changes, restart the Web Services Hub.

InternalHostName

Optional. Host name at which the Web Services Hub listens for connections
from the Integration Service. Default is localhost. To apply changes, restart
the Web Services Hub.

InternalPortNumber

Optional. Port number at which the Web Services Hub listens for connections
from the Integration Service. Default is 15555. To apply changes, restart the
Web Services Hub.

MaxConcurrentRequests

Optional. Maximum number of request processing threads available, which

determines the maximum number of simultaneous requests that can be
handled. Default is 100.

MaxLMConnections

Optional. Maximum number of connections to the Integration Service that can

be open at one time for the Web Services Hub. Default is 20.

MaxQueueLength

Optional. Maximum queue length for incoming connection requests when all
possible request processing threads are in use. Default is 5000.

SessionExpiryPeriod

Optional. Number of seconds that a session can remain unused before its
session ID becomes invalid. Default is 3600 seconds.

URLScheme

Optional. Security protocol that you configure for the Web Services Hub:
HTTP or HTTPS. Default is HTTP. To apply changes, restart the Web
Services Hub.

WSH_ENCODING

Optional. Character encoding for the Web Services Hub. Default is UTF-8. To
apply changes, restart the Web Services Hub.

KeystoreFile

Optional. Keystore file that contains the keys and certificates required if you
use the SSL security protocol with the Web Services Hub.

Chapter 3: infacmd Command Reference

DeleteDARepositoryContents
Deletes repository content from a Data Analyzer repository.
When you delete repository content, you also delete all privileges and roles assigned to users for the Reporting
Service.
The DeleteDARepositoryUsers command uses the following syntax:
DeleteDARepositoryContents
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

The following table describes infacmd DeleteDARepositoryUsers options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password

is case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

-ServiceName
-sn

service_name

Required. Name of the Reporting Service for which

you want to delete contents.

DisableNodeResource
Disables a PowerCenter resource. You can disable file/directory, custom, and connection resources.
When an Integration Service runs on a grid, the Load Balancer can use resources to distribute Session,
Command, and predefined Event-Wait tasks. If the Integration Service is configured to check resources, the
Load Balancer distributes tasks to nodes where the required resources are available.
DeleteDARepositoryContents

By default, all connection resources are enabled on a node. Disable the resources that are not available to
prevent the Load Balancer from dispatching a task to a node that does not have the required resources.
The DisableNodeResource command uses the following syntax:
DisableNodeResource
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceType|-rt> resource_type
("Custom", "File Directory", "Connection")
<-ResourceName|-rn> resource_name

The following table describes infacmd DisableNodeResource options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node where the resource is defined.

-ResourceType
-rt

resource_type

Required. Type of resource. Valid types include:

- Custom
- File Directory
- Connection
To specify a file directory resource, enter file directory in
quotation marks.

-ResourceName
-rn

resource_name

Required. Entire name of the resource. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
To list the names of all resources available to a node, run the
ListNodeResources command.

RELATED TOPICS:
Integration Service Options on page 40

Chapter 3: infacmd Command Reference

DisableService
Disables the application service corresponding to the service name. Use this command to disable any
application service. When you disable a service, all service processes stop.
The DisableService command uses the following syntax:
DisableService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Mode|-mo> disable_mode

The following table describes infacmd DisableService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service you want to disable. To enter a

name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

-Mode
-mo

disable_mode

Required. Defines how the service is disabled:

- Complete. Disables the service after all service processes
stop.
- Stop. If the service is an Integration Service, stops all running
workflows, and then disables the Integration Service.
- Abort. Stops all processes immediately, and then disables the
service.

DisableService

DisableServiceProcess
Disables the service process on a specified node. You can disable a service process on a specified node if the node
requires maintenance.
The DisableServiceProcess command uses the following syntax:
DisableServiceProcess
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-Mode|-mo> disable_mode

The following table describes infacmd DisableServiceProcess options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the service associated with the process

you want to disable. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-NodeName
-nn

node_name

Required. Name of the node where the service process is

running.

-Mode
-mo

disable_mode

Required. Defines how the service process is disabled:

- Complete. Allows the service process to complete the
current tasks before disabling.
- Stop. If the process is an Integration Service process, stops
all running workflows, and then disables the Integration
Service process.
- Abort. Disables the service process before the current task
completes.

Chapter 3: infacmd Command Reference

DisableUser
Disables a user account in a PowerCenter domain. If you do not want a user to access PowerCenter temporarily,
you can disable the user account. When you disable a user account, the user cannot log in to the PowerCenter
applications.
The DisableUser command uses the following syntax:
disableUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]

The following table describes infacmd DisableUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name

of the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information

in the domains.infa file is out of date. The host
names and port numbers for the gateway nodes
in the domain.

-ResilienceTimeout
-re

timeout_period_in_seco
nds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection
to the domain. If you omit this option, infacmd
uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in
the environment variable, the default of 180
seconds is used.

ExistingUserName
-eu

existing_user_name

Required. User account you want to disable. To

enter a name that contains a space or other nonalphanumeric character, enclose the name in
quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security_
domain

Required if you use LDAP authentication. Name

of the security domain that the user you want to
disable belongs to. Default is Native.

DisableUser

EditUser
Edits the general properties for a user account in the native security domain. You cannot modify the properties
of user accounts in the LDAP security domains.
You cannot change the login name of a native user. You can change the password and other details for the user.
The EditUser command uses the following syntax:
editUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserFullName|-ef> Existing_user_full_name]
[<-ExistingUserDescription|-ds> Existing_user_description]
[<-ExistingUserEMailAddress|-em> Existing_user_email_address]
[<-ExistingUserPhoneNumber|-pn> Existing_user_phone_number]

The following table describes infacmd EditUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.

Name of the security domain that the user
belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity

information in the domains.infa file is out of
date. The host names and port numbers for
the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_seconds

Optional. Amount of time in seconds that

infacmd attempts to establish or reestablish a
connection to the domain. If you omit this
option, infacmd uses the timeout value
specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified
in the environment variable, the default of 180
seconds is used.

-ExistingUserName
-eu

existing_user_name

Required. User account you want to edit.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ExistingUserFullName
-sf

existing_user_full_name

Optional. Changed full name for the user

account. To enter a name that contains
spaces or other non-alphanumeric characters,
enclose the name in quotation marks. The full
name cannot include the following special
characters:
<>

-ExistingUserDescription
-ds

existing_user_description

Optional. Changed description for the user

account. To enter a description that contains
spaces or other non-alphanumeric characters,
enclose it in quotation marks.
The description cannot include the following
special characters:
<>

-ExistingUserEMailAddress
-em

existing_user_email_addre
ss

Optional. Changed email address for the user.

To enter an address that contains spaces or
other non-alphanumeric characters, enclose it
in quotation marks.
The email address cannot include the
following special characters:
<>

-ExistingUserPhoneNumber
-pn

existing_user_phone_numb
er

Optional. Changed telephone number for the

user. To enter a telephone number that
contains spaces or other non-alphanumeric
characters, enclose it in quotation marks.
The phone number cannot include the
following special characters:
<>

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 can use resources to distribute Session,
Command, and predefined Event-Wait tasks. If the Integration Service is configured to check resources, the
Load Balancer distributes tasks 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 that node.
The EnableNodeResource command uses the following syntax:
EnableNodeResource
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceType|-rt> resource_type
("Custom", "File Directory", "Connection")
<-ResourceName|-rn> resource_name

EnableNodeResource

The following table describes infacmd EnableNodeResource options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node where the resource is defined.

-ResourceType
-rt

resource_type

Required. Type of resource. Valid types include:

- Custom
- File Directory
- Connection
To specify a file directory resource, enter file directory in
quotation marks.

-ResourceName
-rn

resource_name

Required. Entire name of the resource. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
To list the names of all resources available to a node, run the
ListNodeResources command.

EnableService
Enables the application service corresponding to the service name. Use this command to enable a Repository
Service, Integration Service, Web Services Hub, SAP BW Service, or Reporting Service.
The EnableService command uses the following syntax:
EnableService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

Chapter 3: infacmd Command Reference

The following table describes infacmd EnableService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service you want to enable. To enter a

name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

EnableServiceProcess
Enables a service process on a specified node.
The EnableServiceProcess command uses the following syntax:
EnableServiceProcess
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name

The following table describes infacmd EnableServiceProcess options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

EnableServiceProcess

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service associated with the process you

want to enable. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in quotation
marks.

-NodeName
-nn

node_name

Required. Name of the node where you want to enable a

service process.

EnableUser
Enables a user account in a PowerCenter domain.
The EnableUser command uses the following syntax:
enableUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]

The following table describes infacmd EnableUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both these
methods, the password set with the -pd
option takes precedence. For more
information about configuring environment
variables, see
INFA_DEFAULT_DOMAIN_PASSWORD
on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.

Name of the security domain that the user
belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity

information in the domains.infa file is out of
date. The host names and port numbers for
the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_seconds

Optional. Amount of time in seconds that

infacmd attempts to establish or reestablish
a connection to the domain. If you omit this
option, infacmd uses the timeout value
specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is
specified in the environment variable, the
default of 180 seconds is used.

ExistingUserName
-eu

existing_user_name

Required. User account you want to enable.

To enter a name that contains a space or
other non-alphanumeric character, enclose
the name in quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security_doma
in

Required if you use LDAP authentication.

Name of the security domain that the user
you want to enable belongs to. Default is
Native.

ExportUsersAndGroups
Exports native users and groups in a PowerCenter domain to a file.
Use infacmd ImportUsersAndGroups to import the users and groups from the XML file to a different
PowerCenter domain.
The ExportUsersAndGroups command uses the following syntax:
exportUsersAndGroups
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExportFile|-ef> export_file_name
[<-Force|-f>]

ExportUsersAndGroups

The following table describes infacmd ExportUsersAndGroups options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_seconds

Optional. Amount of time in seconds that infacmd

-ExportFile
-ef

export_file_name

Required. Name and file path where you want to write

the export file.
If you do not specify the file path, infacmd creates the
backup file in the directory where you run infacmd.

-Force
-f

n/a

Optional. Overwrites the export file, if a file with the

same name already exists. If you omit this option, the
command prompts you for a confirmation before it
deletes the file.

RELATED TOPICS:
ImportUsersAndGroups on page 88

GetFolderInfo
Lists folder properties such as folder path, name, and description.
To run the GetFolderInfo command, you must have permission on the folder.
The GetFolderInfo command uses the following syntax:
GetFolderInfo
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderPath|-fp> full_folder_path

Chapter 3: infacmd Command Reference

The following table describes infacmd GetFolderInfo options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, to the

folder. Must be in the format:
/parent_folder/child_folder

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> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-Format|-fm> format_TEXT_XML]
[<-MaxEvents|-me> maximum_number_of_error_events]

GetLastError

The following table describes infacmd GetLastError options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Optional. Name of the service for which you want to fetch

error messages. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-NodeName
-nn

node_name

Required. Name of the node where the service runs.

-Format
-fm

format

Optional. Format for error messages. Valid types include:

- Text
- XML
If you do not specify a format, infacmd displays the messages
in text format with lines wrapped at 80 characters.

-MaxEvents
-me

maximum_number_
of_error_events

Optional. Maximum number of error messages to fetch.

Default is 1. Maximum is 20.

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, SAP BW Service, Metadata Manager Service, Reporting Service, or
Reference Table Manager Service. You can write log events to 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> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]

Chapter 3: infacmd Command Reference

[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]

The following table describes infacmd GetLog options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-StartDate
-sd

start_date_time

Optional. Returns log events starting from this date and time.
Enter date and time in one of the following formats:
- MM/dd/yyyy_hh:mm:ssa_Z
- MM/dd/yyyy_hh:mma_Z
- MM/dd/yyyy_hh:mm:ssa
- MM/dd/yyyy_hh:mma
- yyyy-MM-dd_HH:mm:ss_Z
- yyyy-MM-dd_HH:mm_Z
- yyyy-MM-dd_HH:mm:ss
- yyyy-MM-dd_HH:mm
- MM/dd/yyyy hh:mm:ssa Z
- MM/dd/yyyy hh:mma Z
- MM/dd/yyyy hh:mm:ssa
- MM/dd/yyyy hh:mma
- yyyy-MM-dd HH:mm:ss_Z
- yyyy-MM-dd HH:mm_Z
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm
- MM/dd/yyyy
- yyyy-MM-dd
where a is an am/pm marker (a for a.m. and p for p.m.)
and Z is a time zone marker (for example,-0800 or GMT).

GetLog

Option

Argument

Description

-EndDate
-ed

end_date_time

Optional. Returns log events ending by this date and time.

Enter date and time in the same format as the StartDate
option.
If you enter an end date that is before the start date, GetLog
returns no log events.

-ReverseOrder
-ro

n/a

Optional. Fetches log events according to most recent

timestamp.

-Format
-fm

format

Optional. Format for log events. Valid types include:

- Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name using
the OutputFile option.
If you do not specify a format, infacmd uses text format with
lines wrapped at 80 characters.

-OutputFile
-lo

output_file_name

Name and file path where you want to write the log file. By
default, the Service Manager uses the server\infa_shared\log
directory on the master gateway node.
Omit this option to display the log events on the screen.
If you choose binary as the output file type, you must specify a
file name using this option.

-ServiceType
-st

service_type

Optional. Type of service for which you want to fetch log

events. You can specify one service type.
Omit this option to fetch log events for all service types.
Service types include:
- BW (SAP BW Service)
- DOMAIN (Domain)
- IS (Integration Service)
- RS (Repository Service)
- WS (Web Services Hub)
- MM (Metadata Manager Service)
- RPS (Reporting Service)
- RTM (Reference Table Manager Service)

-ServiceName
-sn

service_name

Optional. Name of the service for which you want to fetch log
events. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

-Severity
-svt

severity_level

Optional. Message severity. Severity types include:

- Fatal
- Error
- Warning
- Info
- Trace
- Debug

GetNodeName
Returns the name of a node. This command fetches the node name from the nodemeta.xml file on the node.
You must enter this command on the node for which you want to fetch the name.
The GetNodeName command uses the following syntax:
GetNodeName

Chapter 3: infacmd Command Reference

GetServiceOption
Fetches the value of a service property for an Integration Service, Repository Service, SAP BW Service, or Web
Services Hub. For example, you can retrieve the repository database type.
The GetServiceOption command uses the following syntax:
GetServiceOption
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-OptionName|-op> option_name

The following table describes infacmd GetServiceOption options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service for which you want to fetch a

value. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

-OptionName
-op

option_name

Required. Name of the option for which you want to retrieve a

value. The options you specify depend on the service type:
- For more information about Integration Service options, see
Integration Service Options on page 40.
- For more information about Repository Service options, see
Repository Service Options on page 53.
- For an SAP BW Service, specify BWSystemConXString (the
SAP Destination R type) or RetryPeriod (the retry period in
seconds).
- For more information about Web Services Hub options, see
Web Services Hub Options on page 64.

GetServiceOption

GetServiceProcessOption
Returns the value of an Integration Service process property running on a node.
The GetServiceProcessOption command uses the following syntax:
GetServiceProcessOption
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-OptionName|-op> option_name

The following table describes infacmd GetServiceProcessOption options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service for which you want to fetch a

value. To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

-NodeName
-nn

node_name

Required. Name of the node where the service process is

running.

-OptionName
-op

option_name

Required. Name of the option for which you want to retrieve a

value. For more information, see Integration Service Process
Options on page 43.

Chapter 3: infacmd Command Reference

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> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name

The following table describes infacmd GetServiceProcessStatus options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service running the process for which

you want the status. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-NodeName
-nn

node_name

Required. Name of the node where the service process is

running.

GetServiceStatus
Returns the status of an application service. You can fetch the status of a Repository Service, Integration
Service, Web Services Hub, or SAP BW Service. A service can be enabled or disabled.

GetServiceProcessStatus

The GetServiceStatus command uses the following syntax:

The following table describes infacmd GetServiceStatus options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the service for which you want the status.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

GetSessionLog
Fetches log events for the most recent run of a session.
Note: The Repository Service must be running when you run this command.

The GetSessionLog command uses the following syntax:

Chapter 3: infacmd Command Reference

The following table describes infacmd GetSessionLog options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-Format
-fm

format

Optional. Format for the session log. Valid types include:

- Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name
using the OutputFile option.
If you do not specify a format, infacmd uses text format
with lines wrapped at 80 characters.

-OutputFile
-lo

output_file_name

Name and file path for the session log file. By default, the
Service Manager uses the server\infa_shared\log
directory on the master gateway node.
Omit this option to display the log events on the screen.
If you choose binary as the output file type, you must
specify a file name using this option.

-IntegrationService
-is

integration_service_
name

Required. Name of the Integration Service that runs the

session.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryService
-rs

repository_service_
name

Required. Name of the Repository Service that contains

the session.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryDomain
-rd

domain_of_repository

Required if the repository is in a domain other than the

local domain. Domain of the Repository Service. To enter
a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

-RepositoryUser
-ru

user

Required. User name used to connect to the repository. To

enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryPassword
-rp

password

Required. User password.

-FolderName
-fn

repository_folder_
name

Required. Name of the folder containing the session. To

enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

GetSessionLog

Option

Argument

Description

-Workflow
-wf

workflow_name

Required. Name of the workflow containing the session.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RunInstance
-in

run_instance_name

Name of the workflow run instance that contains the

session. Use this option if you are running concurrent
workflows. Use the -in or the -id option, not both.

-RunId
-id

workflow_run_id

Run identifier number (Run ID) of the workflow run

instance that contains the session. Use this option if you
are running concurrent workflows. Use the -in or the -id
option, not both.
Note: Use this option if the workflow does not have a
unique run instance name.

-Session
-ss

session_name

Required. Session name. To enter a name that contains a

space or other non-alphanumeric character, enclose the
name in quotation marks.

GetWorkflowLog
Fetches log events for the most recent run of a workflow.
Note: The Repository Service must be running when you run this command.

The GetWorkflowLog command uses the following syntax:

The following table describes infacmd GetWorkflowLog options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-Format
-fm

format

Optional. Format for the session log. Valid types include:

- Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name
using the OutputFile option.
If you do not specify a format, infacmd uses text format
with lines wrapped at 80 characters.

-OutputFile
-lo

output_file_name

Name and file path for the workflow log file. By default, the
Service Manager uses the server\infa_shared\log directory
on the master gateway node. Omit this option to display
the log events on the screen. If you choose binary as the
output file type, you must specify a file name using this
option.

-IntegrationService
-is

integration_service_
name

Required. Name of the Integration Service that runs the

workflow. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

-RepositoryService
-rs

repository_service_
name

Required. Name of the Repository Service that contains

the workflow. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-RepositoryDomain
-rd

domain_of_repository

Required if the repository is in a domain other than the

local domain. Domain of the Repository Service. To enter a
name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

-RepositoryUser
-ru

user

Required. User name used to connect to the repository. To

enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryPassword
-rp

password

Required. User password.

-FolderName
-fn

repository_folder_
name

Required. Name of the folder containing the workflow. To

enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-Workflow
-wf

workflow_name

Required. Name of the workflow. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

-RunInstance
-in

run_instance_name

Name of the workflow run instance. Use this option if you

are running concurrent workflows. Use the -in or the -id
option, not both.

-RunId
-id

workflow_run_id

Run identifier number (Run ID) of the workflow run

instance. Use this option if you are running concurrent
workflows. Use the -in or the -id option, not both.
Note: Use this option if the workflow does not have a
unique run instance name.

GetWorkflowLog

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:
GetServiceStatus <-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

The following table describes the infacmd Help option and argument:
Option

Argument

Description

n/a

command

Optional. Name of command. If you omit the command name, infacmd lists all
commands.

ImportUsersAndGroups
Imports native users and groups into a PowerCenter domain.
Use infacmd ExportUsersAndGroups to export the users and groups to a file.
The ImportUsersAndGroups command uses the following syntax:
ImportUsersAndGroups
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExportFile|-ef> export_file_name
[<-ReuseDomainUsersAndGroups|-rd>]

The following table describes infacmd ImportUsersAndGroups options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ExportFile
-ef

export_file_name

Required. Name and file path of the export file that

contains the information about the users and
groups.

-ReuseDomainUsersAndGroups
-rd

n/a

Optional. In case of a name conflict, retains the

users and groups defined in the target domain. If
you omit this option, the command will fail in case
of a conflict.

RELATED TOPICS:
ExportUsersAndGroups on page 75

ListAlertUsers
Lists users that subscribe to alerts.
The ListAlertUsers command uses the following syntax:
ListAlertUsers
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListAlertUsers options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

ListAlertUsers

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

ListAllGroups
Lists all the groups in the native security domain.
The ListAllGroups command uses the following syntax:
listAllGroups
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes the infacmd ListAllGroups options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_se
conds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

Chapter 3: infacmd Command Reference

ListAllRoles
Lists all the roles in a PowerCenter domain.
The ListAllRoles command uses the following syntax:
listAllRoles
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes the infacmd ListAllRoles options and arguments:
Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_se
conds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

ListAllUsers
Lists all the user accounts in a PowerCenter domain.
The ListAllUsers command uses the following syntax:
listAllUsers
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

ListAllRoles

The following table describes the infacmd ListAllUsers options and arguments:
Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_seconds

Optional. Amount of time in seconds that infacmd

ListDomainLinks
Lists the domains that the local domain can connect to. You establish links between two domains so that you
can exchange repository metadata between them.
The ListDomainLinks command uses the following syntax:
ListDomainLinks
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListDomainLinks options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the local domain.

-UserName
-un

user_name

Required. User name used to connect to the local domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the local domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the local domain.
If you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

ListDomainOptions
Lists domain general properties such as resilience timeout, limit on resilience timeouts, maximum restart
attempts, restart period, and dispatch mode.
To run the ListDomainOptions command, you must have permission on the domain.
The ListDomainOptions command uses the following syntax:
ListDomainOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListDomainOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

ListDomainOptions

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

ListFolders
Lists the folders in the domain.
The ListFolders command uses the following syntax:
ListFolders
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListFolders options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

Chapter 3: infacmd Command Reference

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> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name

The following table describes infacmd ListGridNodes options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-GridName
-gn

grid_name

Required. Name of the grid.

ListGroupPrivileges
Lists privileges assigned to a group in a PowerCenter domain.
You can list privileges assigned to a group for the domain and for each application service in the domain.
The ListGroupPrivileges command uses the following syntax:
listGroupPrivileges
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]

ListGridNodes

The following table describes infacmd ListGroupPrivileges options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-GroupName
-gn

group_name

Required. Name of the group for which you want to list

privileges.

-GroupSecurityDomain
-gsf

group_security_domain

Required if you use LDAP authentication. Name of the

security domain that the group for which you want to list
privileges belongs to. Default is Native.

-ServiceName
-sn

service_name

Required. Domain or application service name for which

you want to view privileges.

ListLDAPConnectivity
Lists the connection information for an LDAP server.
The ListLDAPConnectivity command uses the following syntax:
listLDAPConnectivity
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

Chapter 3: infacmd Command Reference

The following table describes infacmd ListLDAPConnectivity options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

ListLicenses
Lists the licenses in a domain. For each license, infacmd displays the license name and serial number.
To run the ListLicenses command, you must have permission on the licenses.
The ListLicenses command uses the following syntax:
ListLicenses
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port ...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListLicenses options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

ListLicenses

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

ListNodeOptions
Lists the general properties for a node such as backup directory, CPU profile, error severity level, maximum and
minimum process ports, and resource provision thresholds.
To run the ListNodeOptions command, you must have permission on the node.
The ListNodeOptions command uses the following syntax:
ListNodeOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd ListNodeOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-NodeName
-nn

node_name

Required. Name of the node for which you want to list the
options.

ListNodes
Lists all the nodes in a PowerCenter domain.
The ListNodes command uses the following syntax:
listNodes
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListNodes options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

ListNodes

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> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd ListNodeResources options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-NodeName
-nn

node_name

Required. Name of the node for which you want to list the
resources.

ListOSProfiles
Lists the operating system profiles in a domain.
The ListOSProfile command uses the following syntax:
ListOSProfiles
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]

100

Chapter 3: infacmd Command Reference

[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]

[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListOSProfile options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

ListRepositoryLDAPConfiguration
Lists the LDAP server configuration options such as LDAP server address, search scope, and login attributes.
Use this command after you install PowerCenter to verify the connection between the domain and the LDAP
external directory service.
Use infacmd SetRepositoryLDAPConfiguration to update the LDAP server configuration options for a
PowerCenter domain. You use this command when you upgrade from PowerCenter version 8.1.x and earlier to
PowerCenter 8.6 repository that uses LDAP authentication.
The ListRepositoryLDAPConfiguration command uses the following syntax:
listRepositoryLDAPConfiguration
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListRepositoryLDAPConfiguration options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

ListRepositoryLDAPConfiguration

101

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

ListRolePrivileges
Lists privileges assigned to a role in a PowerCenter domain.
You can list privileges assigned to a role for the domain and for each application service type in the domain.
The ListRolePrivileges command uses the following syntax:
listRolePrivileges
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name

The following table describes infacmd ListRolePrivileges options and arguments:

102

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-RoleName
-rn

role_name

Required. Name of the role for which you want to list

privileges. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.

ListSecurityDomains
Lists the native and LDAP security domains in a PowerCenter domain.
listSecurityDomains
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes the infacmd ListSecurityDomains options and arguments:
Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

ListSecurityDomains

103

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_se
conds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

ListServiceLevels
Lists the service levels defined for the domain. This command displays the name, dispatch priority, and
maximum dispatch wait time for each service level.
The ListServiceLevels command uses the following syntax:
ListServiceLevels
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListServiceLevels options and arguments:

104

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

Chapter 3: infacmd Command Reference

ListServiceNodes
Lists the nodes or grid assigned to a service. If this command returns a grid name, you can run the
ListGridNodes command to list the nodes in the grid.
To run the ListServiceNodes command, you must have permission on the service.
The ListServiceNodes command uses the following syntax:
ListServiceNodes
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

The following table describes infacmd ListServiceNodes options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Required. Name of the service.

RELATED TOPICS:
ListGridNodes on page 95

ListServicePrivileges
Lists the privileges for a domain or application service type.

ListServiceNodes

105

The ListServicePrivileges command uses the following syntax:

The following table describes infacmd ListServicePrivileges options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceType
-st

service_type

Optional. Domain or application service type for which you

want to view privileges.
Service types include:
- Domain
- RepositoryService
- MetadataManagerService
- ReportingService
- ReferenceTableManagerService

ListServices
Lists the services in a domain.
The ListServices command uses the following syntax:
ListServices
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-ServiceType|-st> service_type_IS_RS_WS_BW_MM_RTM_RPS]

106

Chapter 3: infacmd Command Reference

The following table describes infacmd ListServices options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceType
-st

service_type

Optional. List all services of a specific type:

- IS. Lists all Integration Services in the domain
- MM. Lists Metadata Manager Services in the domain.
- RPS. Lists all Reporting Services in the domain.
- RS. Lists all Repository Services in the domain.
- RTM. Lists all the Reference Table Manager Services in the
domain.
- WS. Lists all Web Service Hubs in the domain.
- BW. Lists all SAP BW Services in the domain.

ListSMTPOptions
Lists SMTP settings for the outgoing mail server. You must configure SMTP settings to enable users to
subscribe to alerts.
The ListSMTPOptions command uses the following syntax:
ListSMTPOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd ListSMTPOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

ListSMTPOptions

107

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

RELATED TOPICS:
UpdateSMTPOptions on page 161

ListUserPrivileges
Lists privileges assigned to a user in a PowerCenter domain.
You can list privileges assigned to a user for the domain and for each application service in the domain.
The ListUserPrivileges command uses the following syntax:
listUserPrivileges
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-ServiceName|-sn> service_name

The following table describes the infacmd ListUserPrivileges options and arguments:

108

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host
names and port numbers for the gateway nodes in
the domain.

-ResilienceTimeout
-re

timeout_period_in_sec
onds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection
to the domain. If you omit this option, infacmd
uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds
is used.

ExistingUserName
-eu

existing_user_name

Required. User account for which you want to list

privileges. To enter a name that contains a space
or other non-alphanumeric character, enclose the
name in quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user for which you
want to list privileges belongs to. Default is Native.

-ServiceName
-sn

service_name

Required. Domain or application service name for

which you want to view privileges.

MoveFolder
Moves a folder.
The MoveFolder command uses the following syntax:
MoveFolder
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OriginalPath|-op> original_folder_path
<-FolderPath|-fp> full_folder_path

The following table describes infacmd MoveFolder options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

MoveFolder

109

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-OriginalPath
-op

original_folder_path

Required. Full path, excluding the domain name, to the

folder you want to move. Must be in the following format:
/parent_folder/child_folder

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, to the

target folder location. Must be in the following format:
/parent_folder/child_folder

MoveObject
Moves an object from one folder to another.
The MoveObject command uses the following syntax:
MoveObject
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID
<-FolderPath|-fp> full_folder_path

The following table describes infacmd MoveObject options and arguments:

110

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ObjectName
-on

object_name

Required. Name of the object you want to move.

-ObjectType
-ot

object_type

Required. Type of object you want to move:

- Service
- License
- Node
- Grid

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, to the

folder into which you want to move the object. Must be in the
following format:
/parent_folder/child_folder

Ping
Pings a domain, service, domain gateway host, or node. If the object is available, infacmd displays a message
saying that the object is alive at a specific port on the gateway host machine. If the object is unavailable, infacmd
displays a message saying that it failed to receive a response from the object. The Ping command does not
display results for individual service processes.
Use this command to troubleshoot network connections.
To run the Ping command, you must have permission on the object you want to ping.
The Ping command uses the following syntax:
Ping
[<-DomainName|-dn> domain_name]
[<-ServiceName|-sn> service_name]
[<-GatewayAddress|-dg> domain_gateway_host:port]
[<-NodeName|-nn> node_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]

The following table describes infacmd Ping options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required if you do not specify the -GatewayAddress(-dg)

option. Name of the domain.

-ServiceName
-sn

service_name

Optional. Name of the service you want to ping. To enter a

name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

-GatewayAddress
-dg

domain_gateway_host
:port

Required if you do not specify the -DomainName(-dn)

option, or if you need to ping another domain. Gateway host
machine name and port number.

Ping

111

Option

Argument

Description

-NodeName
-nn

node_name

Optional. Name of the node.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

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.
The PurgeLog command uses the following syntax:
PurgeLog
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-BeforeDate|-bd> before_date
[<-LicenseUsage|-lu>]

The following table describes infacmd PurgeLog options and arguments:

112

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

Chapter 3: infacmd Command Reference

Option

Argument

Description

-BeforeDate
-bd

before_date

Required. Purges log events that occurred before this date

and time. Enter date and time in one of the following formats:
- MM/dd/yyyy
- yyyy-MM-dd

-LicenseUsage
-lu

n/a

Optional. Purges log events and database records for license

usage.

RemoveAlertUser
Unsubscribes a user from alert notification emails.
You can run the RemoveAlertUser command for your user. You can also run it for another user.
The RemoveAlertUser command uses the following syntax:
RemoveAlertUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-AlertUser|-au> user_name

The following table describes infacmd RemoveAlertUser options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-AlertUser
-au

user_name

Required. Name of user you want to unsubscribes from

alerts.

RemoveAlertUser

113

RemoveDomainLink
Removes connection information for the linked domain so that you can no longer exchange repository
metadata between the local and linked domains. You may want to do this if you no longer need to access a
Repository Service in another PowerCenter domain.
The RemoveDomainLink command uses the following syntax:
RemoveDomainLink
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LinkedDomainName|-ld> linked_domain_name

The following table describes infacmd RemoveDomainLink options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the local domain.

-UserName
-un

user_name

Required. User name used to connect to the local domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the local domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-LinkedDomainName
-ld

linked_domain_
name

Required. Name of the domain from which you want to

remove a connection.

RemoveFolder
Removes a folder from the domain. The folder must be empty.
The RemoveFolder command uses the following syntax:
RemoveFolder
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
114

Chapter 3: infacmd Command Reference

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderPath|-fp> full_folder_path

The following table describes infacmd RemoveFolder options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, to the

folder you want to remove. Must be in the following format:
/parent_folder/child_folder

RemoveGrid
Removes a grid from a domain. Before you can remove a grid, you must unassign the grid from the Integration
Service.
The RemoveGrid command uses the following syntax:
RemoveGrid
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name

The following table describes infacmd RemoveGrid options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

RemoveGrid

115

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-GridName
-gn

grid_name

Required. Name of the grid you want to remove.

RemoveGroup
Removes a group from the native security domain.
The RemoveGroup command uses the following syntax:
removeGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name

The following table describes infacmd RemoveGroup options and arguments:

116

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-GroupName
-gn

group_name

Required. Name of the group you want to remove.

RemoveGroupPrivilege
Removes a privilege from a group in a PowerCenter domain.
You can remove a privilege from a group for the domain or an application service in the domain.
The RemoveGroupPrivilege command uses the following syntax:
removeGroupPrivilege
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege

The following table describes infacmd RemoveGroupPrivilege options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

RemoveGroupPrivilege

117

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-GroupName
-gn

group_name

Required. Name of the group from which you are removing

the privilege. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-GroupSecurityDomain
-gsf

group_security_dom
ain

Required if you use LDAP authentication. Name of the

security domain that the group from which you are
removing privileges belongs to. Default is Native.

-ServiceName
-sn

service_name

Required. Domain or application service name for which

you want to view privileges.

-PrivilegePath
-pp

path_of_privilege

Required. Fully-qualified name of the privilege you want to

assign to the group. A fully-qualified name includes
privilege group name and privilege name. For example, a
fully-qualified privilege name for the Repository Service is
folder/create. If the privilege name includes spaces,
enclose the path in quotation marks as follows:
Runtime Objects/Monitor/Execute/Manage Execution.
If the privilege name includes the special character /, add
the escape character \ before it as follows:
Model/View Model/Export\ /Import Models.

RemoveLicense
Removes a license from a domain. You remove a license from a domain when it expires or when you want to
move the license to another domain.
Before you run this command, you must first disable the services assigned to the license and then remove the
license from the services.
The RemoveLicense command uses the following syntax:
RemoveLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name

The following table describes infacmd RemoveLicense options and arguments:

118

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-LicenseName
-ln

license_name

Required. Name of the license you want to remove.

RELATED TOPICS:
DisableService on page 67

UnassignLicense on page 140

RemoveNode
Removes a node from a domain. If the node is running, you must shut it down before you can remove it.
The RemoveNode command uses the following syntax:
RemoveNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd RemoveNode options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

RemoveNode

119

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node you want to remove.

RemoveNodeResource
Removes a resource from a node.
When an Integration Service runs on a grid, the Load Balancer can use resources to distribute Session,
Command, and predefined Event-Wait tasks. If the Integration Service is configured to check resources, the
Load Balancer distributes tasks 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.
The RemoveNodeResource command uses the following syntax:
RemoveNodeResource
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceType|-rt> resource_type("Custom", "File Directory")
<-ResourceName|-rn> resource_name

The following table describes infacmd RemoveNodeResource options and arguments:

120

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-NodeName
-nn

node_name

Required. Name of the node that has the resource you want to
remove.

-ResourceType
-rt

resource_type

Required. Type of resource you want to remove. Valid types

include:
- Custom
- File Directory
To specify a file directory resource, enter file directory in
quotation marks.

-ResourceName
-rn

resource_name

Required. Entire name of the resource you want to remove. To

enter a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
To list the names of all resources available to a node, run the
ListNodeResources command.

RemoveOSProfile
Removes an operating system profile from a domain.
The RemoveOSProfile command uses the following syntax:
removeOSProfile
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name

The following table describes infacmd RemoveOSProfile options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

RemoveOSProfile

121

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-OSProfileName
-on

OSProfile_name

Required. Name of the operating system profile you want to

remove.

RemoveRole
Removes a custom role from a domain. When you remove a custom role, the custom role and all privileges that
it included are removed from any user or group assigned the role.
The RemoveRole command uses the following syntax:
removeRole
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name

The following table describes infacmd RemoveRole options and arguments:

122

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-RoleName
-rn

role_name

Required. Name of the role you want to remove.

RemoveRolePrivilege
Removes a privilege from a role in a PowerCenter domain.
You can remove a privilege from a role for the domain or an application service type in the domain.
The RemoveRolePrivilege command uses the following syntax:
RemoveRolePrivileges
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
<-ServiceType|-st> service_type
<-PrivilegePath|-pp> path_of_privilege

The following table describes infacmd RemoveRolePrivilege options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

RemoveRolePrivilege

123

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-RoleName
-rn

role_name

Required. Name of the role from which you are removing

the privilege. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-ServiceType
-st

service_type

Required. Domain or application service type from which

you want to remove the privilege for the role.
Service types include:
- Domain
- RepositoryService
- MetadataManagerService
- ReportingService
- ReferenceTableManagerService

-PrivilegePath
-pp>

path_of_privilege

Required. Fully-qualified name of the privilege you want

to assign to the group. A fully-qualified name includes
privilege group name and privilege name. For example, a
fully-qualified privilege name for the Repository Service is
folder/create. If the privilege name includes spaces,
enclose the path in quotation marks as follows:
Runtime Objects/Monitor/Execute/Manage Execution.
If the privilege name includes the special character /,
add the escape character \ before it as follows:
Model/View Model/Export\ /Import Models.

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.
The RemoveService command uses the following syntax:
RemoveService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

The following table describes infacmd RemoveService options and arguments:

124

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of service you want to remove. To enter a

name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

RemoveServiceLevel
Removes a service level. When you remove a service level, the Workflow Manager does not update tasks that use
the service level. If a workflow service level does not exist in the domain, the Load Balancer dispatches the tasks
with the default service level.
The RemoveServiceLevel command uses the following syntax:
RemoveServiceLevel
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceLevelName|-ln> service_level_name

The following table describes infacmd RemoveServiceLevel options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

RemoveServiceLevel

125

Option

Argument

Description

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceLevelName
-ln

service_level_name

Required. Name of the service level you want to remove.

RemoveUser
Removes a user account from the native security domain. You cannot delete user accounts in the LDAP security
domains.
The RemoveUser command uses the following syntax:
RemoveUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name

The following table describes infacmd RemoveUser options and arguments:

126

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

User name of the user that removes a user.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ExistingUserName
-eu

existing_user_name

Required. User account you want to remove.

RemoveUserFromGroup
Removes a native or LDAP user from a native group in a domain.
The RemoveUserFromGroup command uses the following syntax:
removeUserFromGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-GroupName|-gn> group_name

The following table describes infacmd RemoveUserFromGroup options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name for the user that removes a

user.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host
names and port numbers for the gateway nodes in
the domain.

RemoveUserFromGroup

127

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection
to the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds
is used.

-ExistingUserName
-eu

existing_user_name

Required. Name of the user you want to remove.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user you want to
remove belongs to. Default is Native.

-GroupName
-gn

group_name

Required. Name of the group from which you want

to remove the user.

RemoveUserPrivilege
Removes a privilege from a user in a PowerCenter domain.
You can remove a privilege from a user for the domain or an application service in the domain.
The RemoveUserPrivilege command uses the following syntax:
removeUserPrivilege
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege

The following table describes infacmd RemoveUserPrivilege options and arguments:

128

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes precedence.
For more information about configuring
environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

ExistingUserName
-eu

existing_user_name

Required. User account from which you are

removing the privilege. To enter a name that
contains a space or other non-alphanumeric
character, enclose the name in quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user from which you
are removing the privilege belongs to. Default is
Native.

-ServiceName
-sn

service_name

Required. Domain or application service name for

which you want to view privileges.

-PrivilegePath
-pp

path_of_privilege

Required. Fully-qualified name of the privilege you

want to assign to the group. A fully-qualified name
includes privilege group name and privilege name.
For example, a fully-qualified privilege name for the
Repository Service is folder/create. If the privilege
name includes spaces, enclose the path in
quotation marks as follows:
Runtime Objects/Monitor/Execute/Manage
Execution.
If the privilege name includes the special character
/, add the escape character \ before it as
follows:
Model/View Model/Export\ /Import Models.

ResetPassword
Resets the password for a user in a domain.
The ResetPassword command uses the following syntax:
ResetPassword
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ResetUserName|-ru> reset_user_name
<-ResetUserPassword|-rp> reset_user_password

ResetPassword

129

The following table describes infacmd ResetPassword options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name for the user that resets the password.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ResetUserName
-ru

reset_user_name

Required. Name of the user whose password you want to

reset.

-ResetUserPassword
-rp

reset_user_
password

Required. New password for the user. The password is case

sensitive and must be between 1 and 80 characters long. To
enter a password that contains spaces or other nonalphanumeric characters, enclose it in quotation marks.

RestoreDARepositoryContents
Restores content for a Data Analyzer repository from a binary file.
You can restore metadata from a repository backup file to a database. If you restore the backup file on an
existing database, you overwrite the existing contents.
The RestoreDARepositoryContents command uses the following syntax:
RestoreDARepositoryContents
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-fileName|-f> file_name

130

Chapter 3: infacmd Command Reference

The following table describes infacmd RestoreDARepositoryContents options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the Reporting Service for which you want to

restore contents.

-fileName
-f

file_name

Required. Name and file path of the file to which you backed up
the content.

RunCPUProfile
Calculates the CPU profile for a node.
Note: This command takes approximately five minutes and uses 100% of one CPU on the machine.

The RunCPUProfile command uses the following syntax:

The following table describes infacmd RunCPUProfile options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

RunCPUProfile

131

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-NodeName
-nn

node_name

Required. Name of the node for which you want to calculate

the CPU profile.

SetLDAPConnectivity
Sets up the connection to an LDAP server.
When you set up a connection to an LDAP server, the Service Manager imports the user accounts of all LDAP
security domains from the LDAP server.
The SetLDAPConnectivity command uses the following syntax:
setLDAPConnectivity
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPAddress|-la> ldap_server_address
[<-LDAPPrincipal|-lp> ldap_principal]
[<-LDAPCredential|-lc> ldap_credential]
[<-UseSSL|-us> use_ssl]
[<-TrustLDAPCertificate|-tc> trust_ldap_certificate]
<-LDAPType|-lt> ldap_types=MicrosoftActiveDirectory, SunJavaSystemDirectory, NovellEDirectory, IBMTivoliDirectory, OpenLDAP
[<-MaxSecurityDomainSize|-ms> Max_Security_Domain_size]
[<-GroupMembershipAttr|-gm> LDAP_Group_Membership_Attribute]

The following table describes infacmd SetLDAPConnectivity options and arguments:

132

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host names
and port numbers for the gateway nodes in the
domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses the
timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-LDAPAddress
-la

ldap_server_address

Required. Host name and port number for the

machine hosting the LDAP directory service.
Typically, the LDAP server port number is 389. If the
LDAP server uses SSL, the LDAP server port number
is 636.

-LDAPPrincipal
-lp

ldap_principal

Optional. Distinguished name (DN) for the principal

user. Omit this option to log in as an anonymous user.
For more information, refer to the documentation for
the LDAP directory service.

-LDAPCredential
-lc

ldap_credential

Optional. Password for the principal user. Omit this

option to log in as an anonymous user.

-UseSSL
-us

use_ssl

Optional.Indicates if the LDAP directory service uses

Secure Socket Layer (SSL) protocol.
- TRUE
- FALSE
Default is FALSE.

-TrustLDAPCertificate
-tc

trust_ldap_certificate

Optional. Determines whether PowerCenter can trust

the SSL certificate of the LDAP server.
- TRUE. PowerCenter connects to the LDAP server
without verifying the SSL certificate.
- FALSE. PowerCenter verifies that the SSL certificate
is signed by a Certificate Authority before
connecting to the LDAP server.
Default is FALSE.

-LDAPType
-lt

ldap_types=value

Required. Type of LDAP directory service. Directory

services include:
- MicrosoftActiveDirectory
- SunJavaSystemDirectory
- NovellE-Directory
- IBMTivoliDirectory
- OpenLDAP

-MaxSecurityDomainSize
-ms

Max_Security_Domain_
size

Optional. Maximum number of user accounts to

import into a security domain.
Default is 1000.

-GroupMembershipAttr
-gm

LDAP_Group_Members
hip_Attribute

Optional. Name of the attribute that contains group

membership information for a user.

SetLDAPConnectivity

133

SetRepositoryLDAPConfiguration
Updates the LDAP server configuration options for a PowerCenter repository.
Use this command when you upgrade from PowerCenter version 8.1.x and earlier to a PowerCenter 8.6
repository that uses LDAP authentication. You may need to update the connection information between the
repository and the LDAP external directory service after you install PowerCenter 8.6.
Use infacmd ListRepositoryLDAPConfiguration to view the current values for LDAP server configuration
options.
The SetRepositoryLDAPConfiguration command uses the following syntax:
setRepositoryLDAPConfiguration
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPAddress|-la> ldap_server_address
<-SearchBase|-sb> search base
<-SearchScope|-ss> search scope
<-LDAPPrincipal|-lp> ldap_principal
<-LDAPCredential|-lc> ldap_credential
<-LoginAttribute|-lt> login attribute
<-LoginFilter|-lf> login filter
[<-UseSSL|-us> use_ssl]
[<-CertificateDatabase|-cd> certificate database for ssl]

The following table describes infacmd SetRepositoryLDAPConfiguration options and arguments:

134

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-LDAPAddress
-la

ldap_server_address

Required. Host name and port number for the machine

hosting the LDAP directory service. Typically, the LDAP
server port number is 389.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-SearchBase
-sb

search base

Required. Distinguished name (DN) of the entry that

serves as the starting point to search for user names in
the LDAP directory tree. LDAP finds an object in the
directory according to the path in the distinguished name
of the object. For example, in Microsoft Active Directory,
the distinguished name of a user object might be
cn=UserName,ou=OrganizationalUnit,dc=DomainName,
where the series of relative distinguished names denoted
by dc=DomainName identifies the DNS domain of the
object.

-SearchScope
-ss

search scope

Required. Scope of the user search. Choose one of the

following options:
- Base. Search the entry identified by search base.
- One level. Search all entries one level beneath the
search base entry but not including the search base
entry.
- Subtree. Search the entire subtree at all levels beneath
the search base entry.

-LDAPPrincipal
-lp

ldap_principal

Required. Distinguished name (DN) for the principal user.

The user name often consists of a common name (CN), an
organization (O), and a country (C). The Principal User
Name is an administrative user with access to the
directory and is not the name to authenticate. Specify a
user who has permission to read other user entries in the
LDAP server. Omit this option to log in as an anonymous
user. For more information, refer to the LDAP Server
documentation.

-LDAPCredential
-lc

ldap_credential

Required. Password for the principal user. Omit this option

to log in as an anonymous user.

-LoginAttribute
-lt

login_attribute

Required. Directory attribute that contains login names.

-LoginFilter
-lf

login_filter

Required. An LDAP query string to filter results for user

search. The filter can specify attribute types, assertion
values, and matching criteria. For example:
(objectclass=*) searches all objects.
(&(objectClass=user)(!(cn=susan))) searches all user
objects except susan. For more information about
search filters, see the LDAP server documentation.

-UseSSL
-us

use_ssl

Do not use this option. PowerCenter does not support an

LDAP server that uses SSL for versions 8.1.1 and earlier.

-CertificateDatabase
-cd

certificate_database_f
or_ssl

Do not use this option. PowerCenter does not support an

LDAP server that uses SSL for versions 8.1.1 and earlier.

ShowLicense
Displays license details. The license details you see are a cumulative result of all license keys applied. The
Service Manager updates the existing license details when you add an incremental key to the license.
To run the ShowLicense command, you must have permission on the license.
The ShowLicense command uses the following syntax:
ShowLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
ShowLicense

135

[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name

The following table describes infacmd ShowLicense options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-LicenseName
-ln

license_name

Required. Name of the license.

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.
The ShutdownNode command uses the following syntax:
ShutdownNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd ShutdownNode options and arguments:

136

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node you want to shut down.

SwitchToGatewayNode
Converts an existing worker node to a gateway node.
The SwitchToGatewayNode command uses the following syntax:
SwitchToGatewayNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-LogServiceDirectory|-ld> log_service_directory

The following table describes infacmd SwitchToGatewayNode options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

SwitchToGatewayNode

137

Option

Argument

Description

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node you want to make a gateway

node.

-LogServiceDirectory
-ld

log_service_
directory

Required. Shared directory path used by the Log Manager

to store log event files.

SwitchToWorkerNode
Converts an existing gateway node to a worker node. If the node is serving as the master gateway node, it
remains as the master gateway until it is shut down. When the node is shut down, the Service Managers on the
other gateway nodes elect a new master gateway.
You cannot run this command if the node you want to switch is the only gateway node in the domain.
The SwitchToWorkerNode command uses the following syntax:
SwitchToWorkerNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd SwitchToWorkerNode options and arguments:

138

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-NodeName
-nn

node_name

Required. Name of the node you want to make a worker

node.

UnassignISMMService
Disassociates an Integration Service from a Metadata Manager Service. If you remove an Integration Service,
you must associate another Integration Services before you load resources.
The UnassignISMMService command uses the following syntax:
AssignISMMService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> securitydomain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-IntegrationService|-is> integration_service_name

The following table describes infacmd UnssignISMMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

UnassignISMMService

139

Option

Argument

Description

-ServiceName
-sn

service_name

Required. Name of the Metadata Manager Service you want

to unassign the Integration Service for.

-IntegrationService
-is

integration_service_
name

Required. Name of the Integration Service you want to

unassociate from the Metadata Manager Service.

UnassignLicense
Removes a license from an application service. The service must be stopped. You might need to remove a license
from a service if the service or the license becomes obsolete. After you remove the license from the service, you
cannot enable the service. You must assign a valid license to the service to re-enable it.
The UnassignLicense command uses the following syntax:
UnassignLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
<-ServiceNames|-sn> service1_name service2_name ...

The following table describes infacmd UnassignLicense options and arguments:

140

Option

Arguments

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-LicenseName
-ln

license_name

Required. Name of the license you want to unassign.

-ServiceNames
-sn

service_name1
service_name2 ...

Required. Names of the services for which you want to remove

the license. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in quotation
marks.

Chapter 3: infacmd Command Reference

UnAssignRoleFromGroup
Removes a role from a group for a domain or an application service.
The UnassignRoleFromGroup command uses the following syntax:
unassignRoleFromGroup
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name

The following table describes infacmd UnassignRoleFromGroup options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-GroupName
-gn

group_name

Required. Name of the group from which you want to

remove a role. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.

-GroupSecurityDomain
-gsf

group_security_dom
ain

Required if you use LDAP authentication. Name of the

security domain that the group from which you are
removing the role belongs to. Default is Native.

-RoleName
-rn

role_name

Required. Name of the role you want to remove from the

group.

-ServiceName
-sn

service_name

Required. Domain or application service name from

which you want to remove the role. To enter a name that
contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

UnAssignRoleFromGroup

141

UnAssignRoleFromUser
Removes a role from a user for a domain or an application service.
The UnassignRoleFromUser command uses the following syntax:
unassignRoleFromUser
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_securit
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name

The following table describes infacmd UnassignRoleFromUser options and arguments:

142

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD.
If you set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of

the security domain that the user belongs to.
Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in

the domains.infa file is out of date. The host
names and port numbers for the gateway nodes in
the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to
the domain. If you omit this option, infacmd uses
the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds
is used.

-ExistingUserName
-eu

existing_user_Name

Required. User account from which you are

removing the role. To enter a name that contains a
space or other non-alphanumeric character,
enclose the name in quotation marks.

-ExistingUserSecurityDomain
-esd

existing_user_security
_domain

Required if you use LDAP authentication. Name of

the security domain that the user from which you
are removing the role belongs to. Default is Native.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-RoleName
-rn

role_name

Required. Name of the role you want to remove

from the user.

-ServiceName
-sn

service_name

Required. Domain or application service name

from which you want to remove the role. To enter a
name that contains a space or other nonalphanumeric character, enclose the name in
quotation marks.

UnassignRSWSHubService
Disassociates a repository from a Web Services Hub in a domain.
The UnassignRSWSHubService command uses the following syntax:
UnassignRSWSHubService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name

The following table describes infacmd UnassignRSWSHubService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the Web Services Hub from which

you want to disassociate a repository.

UnassignRSWSHubService

143

Option

Argument

Description

-NodeName
-nn

node_name

Required. Name of the node where the Web Services

Hub process runs. If the PowerCenter environment is
configured for high availability, this option specifies the
name of the primary node.

-RepositoryService
-rs

repository_service_name

Required. Name of the Repository Service that the Web

Services Hub depends on.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

UnassociateDomainNode
Disassociates a node in a domain from its address. When you run this command, the node name remains part of
the domain, but the node has no physical address.
For example, in a domain, Node1 is associated with machine MyHost:9090. When you run this command,
the connection between the name Node1 and the host address MyHost:9090 is removed. You can then
associate Node1 with a new host. You must run the infasetup DefineGatewayNode or DefineWorkerNode
command on the new host to define Node1 on that machine.
The UnassociateDomainNode command uses the following syntax:
UnassociateDomainNode
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name

The following table describes infacmd UnassociateDomainNode options and arguments:

144

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Required. Name of the node you want to disassociate from

the domain.

RELATED TOPICS:
DefineGatewayNode on page 173

DefineWorkerNode on page 175

UpdateDomainOptions
Updates domain general properties such as resilience timeout, limit on resilience timeouts, maximum restart
attempts, restart period, and dispatch mode.
The UpdateDomainOptions command uses the following syntax:
UpdateDomainOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-DomainOptions|-do> option_name=value ...

The following table describes infacmd UpdateDomainOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

UpdateDomainOptions

145

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-DomainOptions
-do

option_name=value

Required. Domain properties you want to update. You can

update the following properties:
- LicenseUsageDetailMinDays. Minimum number of days the
Log Manager keeps log events for license usage.
- LicenseUsageSummaryMinDays. Minimum number of days
the Log Manager keeps database records for license
usage.
- ResilTimeout. Amount of time in seconds services attempt
to connect as clients to other services.
- RestartsMaxAttempts. Number of times within a specified
period that the domain attempts to restart an application
service process when it fails.
- RestartsWithinSeconds. Maximum period of time in
seconds that the domain spends attempting to restart an
application service process when it fails.
- ServiceResilTimeout. Amount of time in seconds that a
service tries to establish or reestablish a connection to
another service.
- TaskDispatchMode. Load Balancer dispatch mode for
tasks: RoundRobin, MetricBased, or Adaptive. Restart the
Integration Service to apply changes.

UpdateDomainPassword
Updates the domain administrator password.
The UpdateDomainPassword command uses the following syntax:
UpdateDomainPassword
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NewPassword|-np> new_password

The following table describes infacmd UpdateDomainPassword options and arguments:

146

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. Administrator name used to connect to the domain.

-Password
-pd

password

Required. Password for the domain administrator.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-NewPassword
-np

new_password

Required. New password for the domain administrator.

UpdateFolder
Updates the folder description.
The UpdateFolder command uses the following syntax:
UpdateFolder
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderPath|-fp> full_folder_path
<-FolderDescription|-fd> description_of_folder

The following table describes infacmd UpdateFolder options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

UpdateFolder

147

Option

Argument

Description

-FolderPath
-fp

full_folder_path

Required. Full path, excluding the domain name, to the

folder you want to update. Must be in the following format:
/parent_folder/child_folder

-FolderDescription
-fd

description_of_folder

Required. Description of the folder.

UpdateGatewayInfo
Updates gateway node connectivity information. Use this command to update the domains.infa file with
current gateway node information.
The UpdateGatewayInfo command uses the following syntax:
UpdateGatewayInfo
<-DomainName|-dn> domain_name
<-GatewayAddress|-dg> domain_gateway_host:port

The following table describes infacmd UpdateGatewayInfo options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-GatewayAddress
-dg

domain_gateway_host:
port

Required. Gateway host machine name and port number.

UpdateGrid
Updates the list of nodes assigned to a grid.
The UpdateGrid command uses the following syntax:
UpdateGrid
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
<-NodeList|-nl> node1 node2 ...

The following table describes infacmd UpdateGrid options and arguments:

148

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-GridName
-gn

grid_name

Required. Name of the grid.

-NodeList
-nl

node1 node2 ...

Required. Names of the nodes you want to assign to the

grid. This list of nodes replaces the list of nodes previously
assigned to the grid.

UpdateIntegrationService
Updates the configuration properties for the Integration Service.
The UpdateIntegrationService command uses the following syntax:
UpdateIntegrationService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-NodeName|-nn> node_name|<-GridName|-gn> grid_name]
[<-BackupNodes|-bn> node1 node2 ...]
[<-RepositoryService|-rs> repository_service_name]
[<-RepositoryUser|-ru> user]
[<-RepositoryPassword|-rp> password]
[<-ServiceOptions|-so> option_name=value ...]

The following table describes infacmd UpdateIntegrationService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

UpdateIntegrationService

149

150

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Integration Service name. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

-NodeName
-nn

node_name

Optional. Name of the node where the Integration Service

process runs. If the PowerCenter environment is
configured for high availability, this option specifies the
name of the primary node.
Do not enter a value for this option if you specify the grid
name.

-GridName
-gn

grid_name

Optional. Name of the grid where the Integration Service

process runs.
Do not enter a value for this option if you specify the node
name.

-BackupNodes
-bn

node1 node2 ...

Optional. If the PowerCenter environment is configured for

high availability, this option specifies the names of the
backup nodes.
Do not enter values for this option if you specify the grid
name.

-RepositoryService
-rs

repository_service_
name

Optional. Name of the Repository Service that the

Integration Service depends on.
To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryUser
-ru

user

Optional. User name used to connect to the repository.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation
marks.

-RepositoryPassword
-rp

password

Optional. User password.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the Integration

Service runs. For more information about Integration
Service options, see Integration Service Options on
page 40.

Chapter 3: infacmd Command Reference

UpdateLicense
Updates license information for a domain. Use this command to upgrade your license using an incremental
license 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.
The UpdateLicense command uses the following syntax:
UpdateLicense
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
<-LicenseKeyFile|-lf> license_key_file

The following table describes infacmd UpdateLicense options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-LicenseName
-ln

license_name

Required. Name of the license object you want to update.

-LicenseKeyFile
-lf

license_key_file

Required. Name and path to the file that contains the

incremental keys.

UpdateMMService
Updates the service options for a Metadata Manager Service. Use this command to update or create service
options for a Metadata Manager Service. To update or create the service options, disable the Metadata Manager
Service, update the options, and re-enable the service.

UpdateLicense

151

The UpdateMMService command uses the following syntax:

The following table describes infacmd UpdateMMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Required. Name of the Metadata Manager Service you want

to update.

-LicenseName
-ln

license_name

Required. Name of the license you want to assign to the

Metadata Manager Service.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the Metadata

Manager Service runs. For more information about
Metadata Manager Service options, see Metadata Manager
Service Options on page 45.

UpdateNodeOptions
Updates node general properties such as backup directory, CPU profile, error severity level, service process
ports, and resource provision thresholds.
The UpdateNodeOptions command uses the following syntax:
UpdateNodeOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name

152

Chapter 3: infacmd Command Reference

The following table describes infacmd UpdateNodeOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

establish or reestablish a connection to the domain. If you
omit this option, infacmd uses the timeout value specified in
the INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment variable,
the default of 180 seconds is used.

-NodeName
-nn

node_name

Optional. Name of the node whose resource provision

thresholds you want to update.

-NodeOptions
-no

option_name=value

Optional. The node options you want to update. You can

update the following options:
- BackupDir. Directory to store repository backup files.
- CPUProfile. Ranking of the CPU performance of the node
compared to a baseline system. ErrorSeverityLevel. Level of
error logging for the node: error, warning, info, trace, debug.
- MaxProcessPort. Maximum port number used by service
processes on the node.
- MinProcessPort. Minimum port number used by service
processes on the node.
The following example sets MaxProcessPort to 1515:
infacmd UpdateNodeOptions ... -no
MaxProcessPort=1515

-ResourceProvision
-rp

option_name=value

Optional. The resource provision thresholds you want to

update. You can update the following thresholds:
- MaxCPURunQueueLength. The maximum number of
runnable threads waiting for CPU resources on the node.
- MaxMemoryPercent. The maximum percentage of virtual
memory allocated on the node relative to the total physical
memory size.
- MaxProcesses. The maximum number of Session and
Command tasks that can run on each Integration Service
running on the node.
The following example sets MaxProcesses to 15:
infacmd UpdateNodeOptions ... -rp
MaxProcesses=15

UpdateNodeOptions

153

UpdateOSProfile
Updates properties for an operating system profile in a domain.
Note: To run workflows that use operating system profiles, you must have the operating system profiles option.

The UpdateOSProfile command uses the following syntax:

The following table describes infacmd UpdateOSProfile options and arguments:

154

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the

domain.

-Password
-pd

password

Optional. Password for the user name. The

password is case sensitive. You can set a
password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both these methods, the
password set with the -pd option takes
precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication.

Name of the security domain that the user
belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity

information in the domains.infa file is out of
date. The host names and port numbers for the
gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that

-OSProfileName
-on

OSProfile_name

Required. Name of the operating system

profile.

-IntegrationServiceProcessOptions
-po

option_name=value

Optional. Service process properties that

define how the Integration Service runs. For
more information about Integration Service
process options, see Integration Service
Process Options for Operating System Profiles
on page 48.

Chapter 3: infacmd Command Reference

UpdateReportingService
Updates the service and lineage options for the Reporting Service. Use this command to create or update service
and lineage options for the Reporting Service.
The UpdateReportingService command uses the following syntax:
updateReportingService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-ServiceOptions|-so> option_name=value]
[<-LineageService|-ls> option_name=value ]

The following table describes infacmd UpdateReportingService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the Reporting Service you want to update.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the Reporting

Service runs. For more information about Reporting Service
options, see Reporting Service Options on page 50.

-LineageService
-ls

option_name=value

Optional. Lineage properties required to perform lineage

analysis for data in Data Analyzer. For more information about
Lineage Service options, see Lineage Service Options on
page 52.

UpdateReportingService

155

UpdateRepositoryService
Updates the service options for the Repository Service. Use this command to update or create service options
for the Repository Service. For example, you can update the Repository Service operating mode, which you can
set to normal or exclusive. Normal mode allows multiple users to access the Repository Service and update
repository contents. Exclusive mode allows a single user to access the Repository Service and update repository
contents. Set the operating mode to exclusive when you perform administrative tasks that require a single user
to log in and update the configuration. To update the Repository Service operating mode, disable the
Repository Service, update the operating mode, and then re-enable the Repository Service.
The UpdateRepositoryService command uses the following syntax:
UpdateRepositoryService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-NodeName|-nn> node_name]
[<-BackupNodes|-bn> node1 node2 ...]
[<-ServiceOptions|-so> option_name=value

The following table describes infacmd UpdateRepositoryService options and arguments:

156

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

sensitive. You can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with the
-pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the Repository Service you want to update.

To enter a name that contains a space or other nonalphanumeric character, enclose the name in quotation marks.

-NodeName
-nn

node_name

Optional. Name of the node where the Repository Service

process runs. If the PowerCenter environment is configured
for high availability, this option specifies the name of the
primary node.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-BackupNodes
-bn

node1 node2 ...

Optional. If the PowerCenter environment is configured for

high availability, this option specifies the names of the backup
nodes.

-ServiceOptions
-so

option_name=value

Required. Service properties that define how the Repository

Service runs. For more information about Repository Service
options, see Repository Service Options on page 53.

UpdateRTMService
Updates the service options for a Reference Table Manager Service. Use this command to create or update
service options for a Reference Table Manager Service.
The UpdateRTMService command uses the following syntax:
UpdateRTMService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-LicenseName|-ln> license_name]
[<-ServiceOptions|-so> option_name=value

The following table describes infacmd UpdateRTMService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Required. Name of the Reference Table Manager Service

you want to update.

UpdateRTMService

157

Option

Argument

Description

-LicenseName
-ln

license_name

Optional. Name of the license assigned to the Reference

Table Manager Service. To apply changes, restart the
service.

-ServiceOptions
-so

option_name=value

Required. Service properties that define how the Reference

Table Manager Service runs. For more information about
Reference Table Manager Service options, see Reference
Table Manager Service Options on page 57.

UpdateSAPBWService
Updates the service and service process options for the SAP BW Service.
The UpdateSAPBWService command uses the following syntax:
UpdateSAPBWService
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-NodeName|-nn> node_name]
[<-ServiceOptions|-so> option_name=value ...]
[<-ServiceProcessOptions|-po> option_name=value ...]

The following table describes infacmd UpdateSAPBWService options and arguments:

158

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set
with the -pd option takes precedence. For more
information about configuring environment variables,
see INFA_DEFAULT_DOMAIN_PASSWORD on
page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ServiceName
-sn

service_name

Required.SAP BW Service name. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

-NodeName
-nn

node_name

Optional. Name of the node where the SAP BW Service

process runs. If the PowerCenter environment is
configured for high availability, this option specifies the
name of the primary node.

-ServiceOptions
-so

option_name=value

Optional. Service properties that define how the SAP

BW Service runs. For more information about SAP BW
Service options, see SAP BW Service Options on
page 60.

-ServiceProcessOptions
-po

option_name=value

Optional. Service process properties that define how

the SAP BW Service process runs. For more
information about SAP BW Service process options,
see SAP BW Service Process Option on page 60.

UpdateServiceLevel
Updates service level properties. You can update the dispatch priority and maximum dispatch wait time.
The UpdateServiceLevel command uses the following syntax:
UpdateServiceLevel
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceLevelName|-ln> service_level_name
<-ServiceLevel|-sl> option_name=value ...

The following table describes infacmd UpdateServiceLevel options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

UpdateServiceLevel

159

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceLevelName
-ln

service_level_name

Required. Name of the service level you want to update.

-ServiceLevel
-sl

option_name=value

Required. The service level properties you want to update.

You can update the following properties:
- DispatchPriority. The initial priority for dispatch. Smaller
numbers have higher priority. Priority 1 is the highest
priority.
- MaxDispatchWaitTime. The amount of time in seconds that
can elapse before the Load Balancer escalates the
dispatch priority for a task to the highest priority.

UpdateServiceProcess
Updates the values of Integration Service process options.
The UpdateServiceProcess command uses the following syntax:
UpdateServiceProcess
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-ServiceProcessOptions|-po> option_name=value

The following table describes infacmd UpdateServiceProcess options and arguments:

160

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information
about configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

attempts to establish or reestablish a connection to the
domain. If you omit this option, infacmd uses the timeout
value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment
variable. If no value is specified in the environment
variable, the default of 180 seconds is used.

-ServiceName
-sn

service_name

Required. Name of the service. To enter a name that

contains a space or other non-alphanumeric character,
enclose the name in quotation marks.

-NodeName
-nn

node_name

Required. Name of the node where you want to update

configuration information.

-ServiceProcessOptions
-pc

option_name=value

Required. Name and new values of the options whose

values you want to update. You can specify multiple
option_name=value pairs. You can use a process
variable in the value.
For example, the following command sets the cache
directory to $PMRootDir/NewCache and the reject file
directory to $PMRootDir/NewBadFiles:
infacmd UpdateServiceProcess ... -po
$PMCacheDir=$PMRootDir/NewCache
$PMBadFileDir=$PMRootDir/NewBadFiles

For more information about service process options, see

Integration Service Process Options on page 43.

UpdateSMTPOptions
Configures SMTP settings for the outgoing mail server to enable a user to subscribe to alerts. After you
configure the SMTP settings, you must subscribe the user to alerts using the AddAlertUser command.
The UpdateSMTPOptions command uses the following syntax:
UpdateSMTPOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SMTPAddress|-sa> smtp_server_address
[<-SMTPUsername|-su> user_name]
[<-SMTPPassword|-sp> password]
[<-SMTPSenderAddress|-ss> sender_email_address]

The following table describes infacmd UpdateSMTPOptions options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

UpdateSMTPOptions

161

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password is

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

to establish or reestablish a connection to the domain. If
you omit this option, infacmd uses the timeout value
specified in the INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is used.

-SMTPAddress
-sa

SMTP_server_
address

Required. The host name and port number for the SMTP
outbound mail server. Enter this information in the
following format:
host_name:port_number

-SMTPUserName
-su

user_name

User name for authentication upon sending, if required by

the outbound mail server.

-SMTPPassword
-sp

password

User password for authentication upon sending, if required

by the outbound mail server.

-SMTPSenderAddress
-ss

sender_email_
address

Optional. Email address the Service Manager uses to send

notification emails. If you leave this field blank, the Service
Manager uses the default Administrator@<host> as the
sender.

Chapter 3: infacmd Command Reference

The following table describes infacmd UpdateWSHubService options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is

case sensitive. You can set a password with the -pd option
or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both these methods, the password set with
the -pd option takes precedence. For more information about
configuring environment variables, see
INFA_DEFAULT_DOMAIN_PASSWORD on page 7.

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts

-ServiceName
-sn

service_name

Required. Name of the Web Services Hub you want to

update.

-NodeName
-nn

node_name

Optional. Name of the node where the Web Services Hub

process runs.

-ServiceOptions
-so

option_name=value
...

Optional. Service properties that define how the Web

Services Hub runs. For more information about Web
Services Hub options, see Web Services Hub Options on
page 64.

UpgradeDARepositoryContents
Upgrades content for a Data Analyzer repository.
You upgrade the contents of the repository to ensure that the metadata in a previous version of the Data
Analyzer repository is compatible with the Reporting Service.
The UpgradeDARepositoryContents command uses the following syntax:
upgradeReportingServiceContents
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name

UpgradeDARepositoryContents

163

The following table describes infacmd UpgradeDARepositoryContents options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

-Password
-pd

password

Optional. Password for the user name. The password is case

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port
...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and port
numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd attempts to

-ServiceName
-sn

service_name

Required. Name of the Reporting Service for which you want to

upgrade contents.

UpgradeDARepositoryUsers
Upgrades users and groups in a Data Analyzer repository.
When you upgrade the users and groups in the Data Analyzer repository, the Service Manager moves them to
the PowerCenter domain.
The UpgradeDARepositoryUsers command uses the following syntax:
UpgradeDARepositoryUsers
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-MigrateSecurityDomain|-msd> migrate_securitydomain

The following table describes infacmd UpgradeDARepositoryUsers options and arguments:

164

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-UserName
-un

user_name

Required. User name used to connect to the domain.

Chapter 3: infacmd Command Reference

Option

Argument

Description

-Password
-pd

password

Optional. Password for the user name. The password

-SecurityDomain
-sdn

security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is
Native.

-Gateway
-hp

gateway_host1:port
gateway_host2:port ...

Required if the gateway connectivity information in the

domains.infa file is out of date. The host names and
port numbers for the gateway nodes in the domain.

-ResilienceTimeout
-re

timeout_period_in_
seconds

Optional. Amount of time in seconds that infacmd

-ServiceName
-sn

service_name

Required. Name of the Reporting Service for the

repository for which you want to upgrade the users and
groups.

-MigrateSecurityDomain
-msd

migrate_securitydomain

Required. Name of the security domain to which you

are moving the uses and groups.

UpgradeDARepositoryUsers

165

166

Chapter 3: infacmd Command Reference

CHAPTER 4

infasetup Command Reference

This chapter contains the following topics:

Using infasetup, 167

Syntax and descriptions for the infasetup commands

Using infasetup
infasetup is a command line program that you use to administer PowerCenter domains and nodes. 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, define, and delete domains, and to define and update nodes.
For more information about performing infasetup tasks through the user interface, see the PowerCenter
Administrator Guide.

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.
Note: In a mixed-version domain, run infasetup from the installation directory of the latest PowerCenter
version.
To run infasetup commands:
1.

At the command prompt, switch to the directory where the infasetup executable is located.
By default, infasetup installs in the server directory.

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...

167

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.

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.
Use the DOS or UNIX echo command immediately after running an infasetup 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 Database Connection Strings

Some infasetup commands use connection strings to connect to the domain configuration database. Specify the
database host, database port, and database service name as part of the connection string.
You can use connection strings with the following infasetup commands:

BackupDomain

DefineDomain

DefineGatewayNode

DeleteDomain

RestoreDomain

UpdateGatewayNode

Table 4-1 lists the connection string syntax for each supported database:
Table 4-1. Database Connection String Syntax

168

Database Name

Connection String

Oracle

Oracle:
jdbc:informatica:oracle://host_name:port;SID=sid
Oracle RAC:
jdbc:informatica:oracle://host_name:port;
ServiceName=[Service
Name];AlternateServers=(server2:port);LoadBalancing
=true

Microsoft SQL Server

jdbc:informatica:sqlserver://host_name:port;
SelectMethod=cursor;DatabaseName=database_name

IBM DB2

jdbc:informatica:db2://host_name:port;
DatabaseName=database_name

Sybase ASE

jdbc:informatica:sybase://host_name:port;DatabaseNa
me=database_name

Chapter 4: infasetup Command Reference

BackupDomain
Backs up the configuration metadata for the domain. infasetup stores the backup domain metadata in an XML
file.
When you run this command, infasetup backs up the following domain configuration database tables:

PCSF_DOMAIN

PCSF_DOMAIN_GROUP_PRIVILEGE

PCSF_DOMAIN_USER_PRIVILEGE

PCSF_GROUP

PCSF_ROLE

PCSF_USER

To restore the domain to another database, you must back up the following tables manually:

PCSF_CPU_USAGE_SUMMARY

PCSF_REPO_USAGE_SUMMARY

PCSF_RUN_LOG

PCSF_SOURCE_AND_TARGET USAGE

The BackupDomain command uses the following syntax:

The following table describes infasetup BackupDomain options and arguments:

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:
database_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

and -DatabaseServiceName (-ds) options.
Connection string used to connect to the domain
configuration database. Specify the database host,
database port, and the database service name as
part of the connection string. Enclose the connection
string in quotes. For more information about
configuring connection strings, see Table 4-1 on
page 168.

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

-DatabasePassword
-dp

database_password

Domain configuration database password

corresponding to the database user. If you omit this
option, infasetup uses the password specified in the
INFA_DEFAULT_DATABASE_PASSWORD
environment variable. If no value is specified in the
environment variable, you must enter a password
using this option.

BackupDomain

169

Option

Argument

Description

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

-DatabaseServiceName
-ds

database_service_na
me

Required if you do not use

-DatabaseConnectionString (-cs) option. The
database service name. Required for Oracle, IBM
DB2, Microsoft SQL Server, and Sybase ASE
databases. Enter the SID for Oracle, the service
name for IBM DB2, or the database name for
Microsoft SQL Server or Sybase ASE.

-BackupFile
-bf

backup_file_name

Required. Name and path for the backup file. If you

do not specify a file path, infasetup creates the
backup file in the current directory.

-Force
-f

n/a

Optional. Overwrites the backup file if a file with the

same name already exists.

-DomainName
-dn

domain_name

Required. Name of the domain.

DefineDomain
Creates a domain on the current machine.
If you define a domain on a machine that currently hosts a domain, you must first stop the Informatica Services
on the machine. When you run this command, infasetup removes the existing domain and node settings. After
you define the new domain, restart Informatica Services.
To create a domain on a Windows machine, you must first open the host port or disable the firewall.
Note: On IBM DB2, the domain configuration database requires a primary tablespace with a default page size of

16K and a temp tablespace size of 16k.

Chapter 4: infasetup Command Reference

[<-Timezone|-tz> log_service_timezone_GMT+00:00]
[<-Force|-f>]

The following table describes infasetup DefineDomain options and arguments:

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:d
atabase_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

and -DatabaseServiceName (-ds) options.
Connection string used to connect to the domain
configuration database. Specify the database host,
database port, and the database service name as
part of the connection string. Enclose the
connection string in quotes. For more information
about configuring connection strings, see Table 4-1
on page 168.

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

-DatabasePassword
-dp

database_password

Domain configuration database password

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

-DatabaseServiceName
-ds

database_service_
name

Required if you do not use

-Tablespace
-ts

tablespace_name

Optional. Name of the tablespace on an IBM DB2

database where the domain configuration database
tables reside.

-DomainName
-dn

domain_name

Required. Name of the domain. Domain names

must be between 1 and 79 characters and cannot
contain spaces or the following characters: / * ? < >
"|

-AdministratorName
-ad

administrator_name

Required. Domain administrator user name.

-Password
-pd

password

Required. Domain administrator password.

-LogServiceDirectory
-ld

log_service_directory

Required. Shared directory path used by the Log

Manager to store log event files.

-NodeName
-nn

node_name

Required. Name of the node. Node names must be

between 1 and 79 characters and cannot contain
spaces or the following characters: \ / * ? < > " |

DefineDomain

171

Option

Argument

Description

-NodeAddress
-na

node_host:port

Required. Host name and port number for the

machine hosting the node. Choose an available port
number.

-HttpsPort
-hs

https_port

Optional. Port number that the node uses for

communication between the Administration Console
and the Service Manager. Set this port number if
you want to configure HTTPS for a node.

-KeystoreFile
-kf

keystore_file_location

Optional. Keystore file that contains the keys and

certificates required if you use the SSL security
protocol with PowerCenter.

-KeystorePass
-kp

keystore_password

Optional. A plain-text password for the keystore file.

-MinProcessPort
-mi

minimum_port

Required. Minimum port number for application

service processes that run on the node.

-MaxProcessPort
-ma

maximum_port

Required. Maximum port number for application

service processes that run on the node.

-ServerPort
-sv

server_admin_port_
number

Optional. TCP/IP port number used by the Service

Manager. The Service Manager listens for shutdown
commands from PowerCenter components on this
port. Set this port number if you have multiple nodes
on one machine or if the default port number is in
use. Default is the node port number plus one.

-BackupDirectory
-bd

backup_directory

Optional. Directory to store repository backup files.

The directory must be accessible by the node.

-ServiceResilienceTimeout
-sr

timeout_period_in_
seconds

Optional. Amount of time in seconds that infasetup

attempts to establish or reestablish a connection to
the local domain. If you omit this option, infasetup
uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT
environment variable. If no value is specified in the
environment variable, the default of 180 seconds is
used.

-ErrorLogLevel
-el

fatal
error
warning
info
trace
debug

Optional. Severity level for log events in the domain

log. Default is info.

-ResourceFile
-rf

resource_file

Required. File that contains the list of available

resources for the node. Use the file,
nodeoptions.xml, located in the server\tomcat\bin
directory.

-TimeZone
-tz

log_service_
timezone_GMT+00:00

Optional. Time zone used by the Log Manager when

it generates log event files. Default is GMT+00:00.
Configure the time zone in the following format:
GMT(+/-)hh:mm

-Force
-f

n/a

Optional. Overwrites the database if a database with

the same name already exists.

If you run DefineDomain on a node that currently hosts a domain, reconfigure the following domain
properties:

172

Application services. Recreate any application service that ran on the domain.

Users. Recreate users.

Gateway nodes. Configure the gateway nodes in the domain.

General domain properties. Configure resilience timeout and maximum restart attempts for the domain.

Chapter 4: infasetup Command Reference

Grids. Recreate any grid in the domain.

LDAP authentication. Configure LDAP authentication for the domain.

Log Manager properties. Configure the Log Manager shared directory path, purge properties, and time
zone.

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.

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.
The DefineGatewayNode command uses the following syntax:
DefineGatewayNode
<<-DatabaseAddress|-da> database_hostname:database_port|
<-DatabaseConnectionString|-cs> database_connection_string>
<-DatabaseUserName|-du> database_user_name
<-DatabasePassword|-dp> database_password
<-DatabaseType|-dt> database_type
[<-DatabaseServiceName|-ds> database_service_name]
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-NodeAddress|-na> node_host:port
[<-PreviousInfaHome|-ph> previous_infa_home]
[<-HttpsPort|-hs> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePass|-kp> keystore_password]
[<-MinProcessPort|-mi> minimum_port]
[<-MaxProcessPort|-ma> maximum_port]
<-LogServiceDirectory|-ld> log_service_directory
[<-BackupDirectory|-bd> backup_directory]
[<-ErrorLogLevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG]
[<-ServerPort|-sv> server_admin_port_number]
<-ResourceFile|-rf> resource_file

The following table describes infasetup DefineGatewayNode options and arguments:

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:
database_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

DefineGatewayNode

173

174

Option

Argument

Description

-DatabasePassword
-dp

database_password

Domain configuration database password

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

-DatabaseServiceName
-ds

database_service_
name

Required if you do not use

-DomainName
-dn

domain_name

Required. Name of the domain the gateway node

links to.

-NodeName
-nn

node_name

Required. Name of the node. Node names must be

between 1 and 79 characters and cannot contain
spaces or the following characters: \ / * ? < > " |

-NodeAddress
-na

node_host:port

Required. Host name and port number for the

machine hosting the node. Choose an available port
number.

-PreviousInfaHome
-ph

previous_infa_home

Optional. Previous PowerCenter installation

directory. Set the previous PowerCenter installation
directory to run multiple service versions on the
node. The previous installation directory cannot be
the same as the latest installation directory. After
you configure a node to support multiple service
version, you cannot configure the node to support a
single service version.

-HttpsPort
-hs

https_port

Optional. Port number that the node uses for

communication between the Administration Console
and the Service Manager. Set this port number if you
want to configure HTTPS for a node.

-KeystoreFile
-kf

keystore_file_location

Optional. Keystore file that contains the keys and

certificates required if you use the SSL security
protocol with PowerCenter.

-KeystorePass
-kp

keystore_password

Optional. A plain-text password for the keystore file.

-MinProcessPort
-mi

minimum_port

Optional. Minimum port number for application

service processes that run on the node. Default is
11000.

-MaxProcessPort
-ma

maximum_port

Optional. Maximum port number for application

service processes that run on the node. Default is
11999.

-LogServiceDirectory
-ld

log_service_directory

Required. Shared directory path used by the Log

Manager to store log event files.

-BackupDirectory
-bd

backup_directory

Optional. Directory to store repository backup files.

The directory must be accessible by the node.

Chapter 4: infasetup Command Reference

Option

Argument

Description

-ErrorLogLevel
-el

fatal
error
warning
info
trace
debug

Optional. Severity level for log events in the domain

log. Default is info.

-ServerPort
-sv

server_admin_port_
number

Optional. TCP/IP port number used by the Service

-ResourceFile
-rf

resource_file

Required. File that contains the list of available

resources for the node. Use the file,
nodeoptions.xml, located in the server\tomcat\bin
directory.

RELATED TOPICS:
AddDomainNode on page 14

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.
The DefineWorkerNode command uses the following syntax:
DefineWorkerNode
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-NodeAddress|-na> node_host:port
[<-PreviousInfaHome|-ph> previous_infa_home]
[<-HttpsPort|-hs> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePass|-kp> keystore_password]
<-GatewayAddress|-dg> domain_gateway_host:port
<-UserName|-un> user_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

The following table describes infasetup DefineWorkerNode options and arguments:

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain the worker node links to.

-NodeName
-nn

node_name

Required. Name of the node. Node names must be

between 1 and 79 characters and cannot contain spaces or
the following characters: \ / * ? < > " |

DefineWorkerNode

175

Option

Argument

Description

-NodeAddress
-na

node_host:port

Required. Host name and port number for the machine

hosting the node. Choose an available port number.

-PreviousInfaHome
-ph

previous_infa_home

Optional. Previous PowerCenter installation directory. Set

the previous PowerCenter installation directory to run
multiple service versions on the node. The previous
installation directory cannot be the same as the latest
installation directory. After you configure a node to support
multiple service version, you cannot configure the node to
support a single service version.

-HttpsPort
-hs

https_port

Optional. Port number that the node uses for

communication between the Administration Console and
the Service Manager. Set this port number if you want to
configure HTTPS for a node.

-KeystoreFile
-kf

keystore_file_location

Optional. Keystore file that contains the keys and

certificates required if you use the SSL security protocol
with PowerCenter.

-KeystorePass
-kp

keystore_password

Optional. A plain-text password for the keystore file.

-GatewayAddress
-dg

domain_gateway_
host:port

Required. Gateway host machine name and port number.

-UserName
-un

user_name

Required. User name.

-Password
-pd

password

Required. User password.

-MinProcessPort
-mi

minimum_port

Optional. Minimum port number for application service

processes that run on the node. Default is 11000.

-MaxProcessPort
-ma

maximum_port

Optional. Maximum port number for application service

processes that run on the node. Default is 11999.

-BackupDirectory
-bd

backup_directory

Optional. Directory to store repository backup files. The

directory must be accessible by the node.

-ErrorLogLevel
-el

fatal
error
warning
info
trace
debug

Optional. Severity level for log events in the domain log.

Default is info.

-ServerPort
-sv

server_admin_port_
number

Optional. TCP/IP port number used by the Service

Manager. The Service Manager listens for shutdown
commands from PowerCenter components on this port. Set
this port number if you have multiple nodes on one
machine or if the default port number is in use. Default is
8005.

-ResourceFile
-rf

resource_file

Required. File that contains the list of available resources

for the node. Use the file, nodeoptions.xml, located in the
server\tomcat\bin directory.

DeleteDomain
Deletes domain metadata tables.
Before you run this command, you must stop the Informatica Services on the machine. To delete a domain on a
Windows machine, you must also open the host port or disable the firewall.

176

Chapter 4: infasetup Command Reference

The DeleteDomain command uses the following syntax:

The following table describes infasetup DeleteDomain options and arguments:

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:
database_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

and -DatabaseServiceName (-ds) options.
Connection string used to connect to the domain
configuration database. Specify the database host,
database port, and the database service name as
part of the connection string. Enclose the
connection string in quotes. For more information
about configuring connection strings, see Table 4-1
on page 168.

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

-DatabasePassword
-dp

database_password

Domain configuration database password

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

-DatabaseServiceName
-ds

database_service_
name

Required if you do not use

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]

Help

177

For example, if you type infasetup Help UpdateWorkerNode, infasetup returns the following options and
arguments for the UpdateWorkerNode command:
UpdateWorkerNode [<-DomainName|-dn> domain_name]
[<-NodeName|-nn> node_name]
[<-NodeAddress|-na> node_host:port]
[<-GatewayAddress|-dg> domain_gateway_host:port]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-ServerPort|-sv> server_admin_port_number]

The following table describes the infasetup Help option and argument:
Option

Argument

Description

n/a

command

Optional. Name of command. If you omit the command name, infasetup lists all
commands.

RestoreDomain
Restores the configuration metadata for the domain from a backup XML file. You must shut down the domain
before you run this command.
PowerCenter restores the domain from the current version. If you have a backup file from an earlier version of
PowerCenter, you must use the earlier version to restore the domain.
When you run this command, infasetup restores the following domain configuration database tables:

PCSF_DOMAIN

PCSF_DOMAIN_GROUP_PRIVILEGE

PCSF_DOMAIN_USER_PRIVILEGE

PCSF_GROUP

PCSF_ROLE

PCSF_USER

If you restore the domain into a database other than the original backup database, you must restore the
following tables manually:

PCSF_CPU_USAGE_SUMMARY

PCSF_REPO_USAGE_SUMMARY

PCSF_RUN_LOG

PCSF_SOURCE_AND_TARGET_USAGE

The RestoreDomain command uses the following syntax:

178

Chapter 4: infasetup Command Reference

The following table describes infacmd RestoreDomain options and arguments:

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:
database_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

and -DatabaseServiceName (-ds) options.
Connection string used to connect to the domain
configuration database. Specify the database host,
database port, and the database service name as
part of the connection string. Enclose the
connection string in quotes. For more information
about configuring connection strings, see Table 4-1
on page 168.

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

-DatabasePassword
-dp

database_password

Domain configuration database password

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

-DatabaseServiceName
-ds

database_service_
name

Required if you do not use

-BackupFile
-bf

backup_file_name

Required. Name and path for the backup file. If you

do not specify a file path, infasetup creates the
backup file in the current directory.

-Force
-f

n/a

Optional. Overwrites the database if a database

with the same name already exists.

-ClearNodeAssociation
-ca

n/a

Optional. Clears node associations when restoring

the domain. For example, a backed up domain
contains node Node1 on machine MyHost:9090.
If you specify this option, the connection between
the node name Node1 and the address
MyHost:9090 is broken when you restore the
domain. You can then associate another node with
MyHost:9090.
If you do not specify this option, Node1 retains its
connection to MyHost:9090. If you restore the
domain and associate another node with
MyHost:9090, the node does not start.

-Tablespace
-ts

tablespace_name

Optional. Name of the tablespace on an IBM DB2

database where the domain configuration database
tables reside.

RestoreDomain

179

UpdateGatewayNode
Updates connectivity information for a gateway node on the current machine. To run this command, you must
first shut down the node.
Warning: If the domain contains a single gateway node, and you update the node address using this command,

the Service Manager will not be able to communicate with the node when you restart the node. If this happens,
back up the domain, update the node address in the backup file, and restore the database.
The UpdateGatewayNode command uses the following syntax:
UpdateGatewayNode
[<-DatabaseAddress|-da> database_hostname:database_port
<-DatabaseConnectionString|-cs> database_connection_string]
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
[<-DatabaseType|-dt> database_type]
[<-DatabaseServiceName|-ds> database_service_name]
[<-DomainName|-dn> domain_name]
[<-NodeName|-nn> node_name]
[<-NodeAddress|-na> node_host:port]
[<-PreviousInfaHome|-ph> previous_infa_home]
[<-HttpsPort|-hs> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePass|-kp> keystore_password]
[<-LogServiceDirectory|-ld> log_service_directory]
[<-ServerPort|-sv> server_admin_port_number]

The following table describes infasetup UpdateGatewayNode options and arguments:

180

Option

Argument

Description

-DatabaseAddress
-da

database_hostname:
database_port

Required if you do not use

-DatabaseConnectionString (-cs) option. Name and
port number of the machine hosting the domain
configuration database.

-DatabaseConnectionString
-cs

database_connection
_string

Required if you do not use -DatabaseAddress (-da)

and -DatabaseServiceName (-ds) options.
Connection string used to connect to the domain
configuration database. Specify the database host,
database port, and the database service name as
part of the connection string. Enclose the
connection string in quotes. For more information
about configuring connection strings, see Table 4-1
on page 168

-DatabaseUserName
-du

database_user_name

Required. Account for the database containing the

domain configuration information.

-DatabasePassword
-dp

database_password

Domain configuration database password

-DatabaseType
-dt

database_type

Required. Type of database that stores the domain

configuration metadata. Database types include:
- db2
- oracle
- sqlserver
- sybase

Chapter 4: infasetup Command Reference

Option

Argument

Description

-DatabaseServiceName
-ds

database_service_
name

Required if you do not use

-DomainName
-dn

domain_name

Required. Name of the domain.

-NodeName
-nn

node_name

Optional. Name of the node. Node names must be

between 1 and 79 characters and cannot contain
spaces or the following characters: \ / * ? < > " |

-NodeAddress
-na

node_host:port

Optional. Host name and port number for the

machine hosting the node. Choose an available port
number.

-PreviousInfaHome
-ph

previous_infa_home

Optional. Previous PowerCenter installation

-HttpsPort
-hs

https_port

Optional. Port number that the node uses for

communication between the Administration Console
and the Service Manager. Set this port number if
you want to configure HTTPS for a node.

-KeystoreFile
-kf

keystore_file_location

Optional. Keystore file that contains the keys and

certificates required if you use the SSL security
protocol with PowerCenter.

-KeystorePass
-kp

keystore_password

Optional. A plain-text password for the keystore file.

-LogServiceDirectory
-ld

log_service_directory

Optional. Shared directory path used by the Log

Manager to store log event files.

-ServerPort
-sv

server_admin_port_
number

Optional. TCP/IP port number used by the Service

Manager. The Service Manager listens for shutdown
commands from PowerCenter components on this
port. Set this port number if you have multiple
nodes on one machine or if the default port number
is in use.

UpdateWorkerNode
Updates connectivity information for a worker node on the current machine. To run this command, you must
first shut down the node.
The UpdateWorkerNode command uses the following syntax:
UpdateWorkerNode
[<-DomainName|-dn> domain_name]
[<-NodeName|-nn> node_name]
[<-NodeAddress|-na> node_host:port]
[<-PreviousInfaHome|-ph> previous_infa_home]
[<-HttpsPort|-hs> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePass|-kp> keystore_password]

UpdateWorkerNode

181

[<-GatewayAddress|-dg> domain_gateway_host:port]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-ServerPort|-sv> server_admin_port_number]

The following table describes infasetup UpdateWorkerNode options and arguments:

182

Option

Argument

Description

-DomainName
-dn

domain_name

Required. Name of the domain.

-NodeName
-nn

node_name

Optional. Name of the node. Node names must be between

1 and 79 characters and cannot contain spaces or the
following characters: \ / * ? < > " |

-NodeAddress
-na

node_host:port

Optional. Host name and port number for the machine

hosting the node. Choose an available port number.

-PreviousInfaHome
-ph

previous_infa_home

Optional. Previous PowerCenter installation directory. Set

-HttpsPort
-hs

https_port

Optional. Port number that the node uses for

communication between the Administration Console and
the Service Manager. Set this port number if you want to
configure HTTPS for a node.

-KeystoreFile
-kf

keystore_file_location

Optional. Keystore file that contains the keys and

certificates required if you use the SSL security protocol
with PowerCenter.

-KeystorePass
-kp

keystore_password

Optional. A plain-text password for the keystore file.

-GatewayAddress
-dg

domain_gateway_
host:port

Optional. Gateway host machine name and port number.

-UserName
-un

user_name

Optional. User name.

-Password
-pd

password

Optional. User password.

-ServerPort
-sv

server_admin_port_
number

Optional. TCP/IP port number used by the Service

Manager. The Service Manager listens for shutdown
commands from PowerCenter components on this port. Set
this port number if you have multiple nodes on one machine
or if the default port number is in use.

Chapter 4: infasetup Command Reference

CHAPTER 5

pmcmd Command Reference

This chapter includes the following topics:

Using pmcmd, 183

Syntax and descriptions for the pmcmd commands

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 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. The environment variables apply to pmcmd commands that run on the node.
Note: If the domain is a mixed-version domain, run pmcmd from the installation directory of the Integration
Service version.

Running Commands in Command Line Mode

Command line mode invokes and exits pmcmd each time you issue a command. Command line mode is useful
if you want to run pmcmd commands through batch files, scripts, or other programs.
Use pmcmd commands with operating system scheduling tools like cron, or you can embed pmcmd commands
into shell or Perl scripts.
When you run pmcmd in command line mode, you enter connection information such as domain name,
Integration Service name, user name and password in each command. For example, to start the workflow
wf_SalesAvg in folder SalesEast, use the following syntax:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast
wf_SalesAvg

183

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 184.
To run pmcmd commands in command line mode:
1.

At the command prompt, switch to the directory where the pmcmd executable is located.
By default, the PowerCenter installer installs pmcmd in the \server\bin directory.

Enter pmcmd followed by the command name and its required options and arguments:
pmcmd command_name [-option1] argument_1 [-option2] argument_2...

Return Codes
In command line mode, pmcmd indicates the success or failure of a command with a return code. Return code
0 indicates that the command succeeded. Any other return code indicates that the command failed.
Use the DOS or UNIX echo command immediately after running a pmcmd command to see the return code for
the command:

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:

Table 5-1. pmcmd Return Codes

184

Code

Description

For all commands, a return value of zero indicates that the command ran successfully. You can
issue the following commands in the wait or nowait mode: starttask, startworkflow, aborttask, and
abortworkflow. If you issue a command in the wait mode, a return value of zero indicates the
command ran successfully. If you issue a command in the nowait mode, a return value of zero
indicates that the request was successfully transmitted to the Integration Service, and it
acknowledged the request.

Integration Service is not available, or pmcmd cannot connect to the Integration Service. There is
a problem with the TCP/IP host name or port number or with the network.

Task name, workflow name, or folder name does not exist.

An error occurred starting or running the workflow or task.

Usage error. You passed the wrong options to pmcmd.

An internal pmcmd error occurred. Contact Informatica Global Customer Support.

You used an invalid user name or password.

You do not have the appropriate permissions or privileges to perform this task.

Connection to the Integration Service timed out while sending the request.

Integration Service cannot start recovery because the session or workflow is scheduled, waiting
for an event, waiting, initializing, aborting, stopping, disabled, or running.

User name environment variable is set to an empty value.

Password environment variable is set to an empty value.

User name environment variable is missing.

Password environment variable is missing.

Parameter file does not exist.

Integration Service found the parameter file, but it did not have the initial values for the session
parameters, such as $input or $output.

Chapter 5: pmcmd Command Reference

Table 5-1. pmcmd Return Codes

Code

Description

Integration Service cannot resume the session because the workflow is configured to run
continuously.

A repository error has occurred. Make sure that the Repository Service and the database are
running and the number of connections to the database is not exceeded.

Integration Service is shutting down and it is not accepting new requests.

Integration Service cannot find a unique instance of the workflow/session you specified. Enter the
command again with the folder name and workflow name.

There is no data available for the request.

Out of memory.

Command is cancelled.

Running Commands in Interactive Mode

Use pmcmd in interactive mode to start and stop workflows and sessions without writing a script. When you use
the interactive mode, you enter connection information such as domain name, Integration Service name, user
name, and password. You can run subsequent commands without entering the connection information for each
command.
For example, the following commands invoke the interactive mode, establish a connection to Integration
Service MyIntService, and start workflows wf_SalesAvg and wf_SalesTotal in folder SalesEast:
pmcmd
pmcmd>
pmcmd>
pmcmd>
pmcmd>

connect -sv MyIntService -d MyDomain -u seller3 -p jackson

setfolder SalesEast
startworkflow wf_SalesAvg
startworkflow wf_SalesTotal

To run pmcmd commands in interactive mode:

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.

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.

Enter connection information for the domain and Integration Service. For example:
connect -sv MyIntService -d MyDomain -u seller3 -p jackson

Type a command and its options and arguments in the following format:
command_name [-option1] argument_1 [-option2] argument_2...

pmcmd runs the command and displays the prompt again.

Type exit to end an interactive session.

Setting Defaults
After you connect to an Integration Service using pmcmd, you can designate default folders or conditions to use
each time the Integration Service executes a command. For example, if you want to issue a series of commands
or tasks in the same folder, specify the name of the folder with the setfolder command. All subsequent
commands use that folder as the default.

Using pmcmd

185

The following table 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.

unsetfolder

Reverses the setfolder command.

You can use pmcmd ShowSettings command to display the default settings.

Running in Wait Mode

You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt
after the command completes. You cannot run subsequent commands until the previous command completes.
For example, if you enter the following command, pmcmd starts the workflow wf_SalesAvg and does not
return to the prompt until the workflow completes:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast -wait
wf_SalesAvg

In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to wait for one
command to complete before running the next command.
For example, if you enter the following commands, pmcmd starts workflow wf_SalesTotal even if workflow
wf_SalesAvg is still running:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast
wf_SalesAvg
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f SalesEast
wf_SalesTotal

By default, pmcmd executes commands in nowait mode.

You can configure the wait mode when you run in command line or interactive mode. In command line mode,
use the -wait option to run a command in wait mode. In interactive mode, use the setwait or setnowait
command before entering subsequent commands.

Scripting pmcmd Commands

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

186

Chapter 5: pmcmd Command Reference

if [ "$?" != 0 ]; then
# handle error
echo "Could not get service properties"
exit
fi
# Get task details for session task "s_testSessionTask" of workflow
# "wf_test_workflow" in folder "testFolder"
pmcmd gettaskdetails -sv testService -d testDomain -u Administrator -p adminPass -folder
testFolder -workflow wf_test_workflow s_testSessionTask
if [ "$?" != 0 ]; then
# handle error
echo "Could not get details for task s_testSessionTask"
exit
fi

Entering Command Options

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

To enter a password, precede the password with the -password or -p option:

-password ThePassword
or
-p ThePassword

If you use a password environment variable, precede the variable name with the -pv or -passwordvar option:
-passwordvar PASSWORD
or
-pv PASSWORD

If a command option contains spaces, use single or double quotation marks to enclose the option. For example,
use single quotes in the following syntax to enclose the folder name:
abortworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson -f 'quarterly sales' wait wf_MyWorkflow

To denote an empty string, use two single quotes ('') or two double quotes ("").

The aborttask command uses the following syntax in the interactive mode:
aborttask
[<-folder|-f> folder]

aborttask

187

<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath

The following table describes pmcmd aborttask options and arguments:

188

Option

Argument

Description

-service
-sv

service

Required in command line mode. Integration Service

name. Not used in interactive mode.

-domain
-d

domain

Optional in command line mode. Domain name. Not used

in interactive mode.

-timeout
-t

timeout

Optional in command line mode. Amount of time, in

seconds, pmcmd attempts to connect to the Integration
Service. Not used in interactive mode.
If the -timeout option is omitted, pmcmd uses the timeout
value specified in the environment variable
INFA_CLIENT_RESILIENCE_TIMEOUT. If the
environment variable is not set, pmcmd uses the default
timeout value. Default is 180.

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Required in command line mode if you do not specify the

user name. Specifies the user name environment
variable. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the task name is not unique in the repository.

Name of the folder containing the task.

-workflow
-w

workflow

Required. Name of the workflow.

-wait
-nowait

n/a

Optional. Configures the wait mode:

- wait. You can enter a new pmcmd command only after
the Integration Service completes the previous
command.
- nowait. You can enter a new pmcmd command after the
Integration Service receives the previous command.
Default is nowait.

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task

you want to abort. Use this option if you are running
concurrent workflows.

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance that contains the task you want to abort. Use this
option if you are running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

n/a

taskInstancePath

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]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

The following table describes pmcmd abortworkflow options and arguments:

Option

Argument

Description

-service
-sv

service

Required in command line mode. Integration Service

name. Not used in interactive mode.

-domain
-d

domain

Optional in command line mode. Domain name. Not used

in interactive mode.

-timeout
-t

timeout

Optional in command line mode. Amount of time, in

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

abortworkflow

189

Option

Argument

Description

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-wait
-nowait

n/a

Optional. Configures the wait mode:

-runinsname
-rin

runInsName

Name of the workflow run instance you want to abort. Use

this option if you are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance you want to abort. Use this option if you are
running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

n/a

workflow

Required. Name of the workflow.

connect
Connects the pmcmd program to the Integration Service in the interactive mode. If you omit connection
information, pmcmd prompts you to enter the correct information. Once pmcmd successfully connects, you can
issue commands without reentering the connection information.
connect
<<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
<<-user|-u> username|<-uservar|-uv> userEnvVar>
<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]

Note: Use this command in the pmcmd interactive mode only.

190

Chapter 5: pmcmd Command Reference

The following table describes pmcmd connect options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

connect to the Integration Service.
If the -timeout option is omitted, pmcmd uses the timeout
value specified in the environment variable
INFA_CLIENT_RESILIENCE_TIMEOUT. If the
environment variable is not set, pmcmd uses the default
timeout value. Default is 180.

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

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

Note: Use this command in the pmcmd interactive mode only.

exit
Disconnects pmcmd from the Integration Service and closes the pmcmd program.
The exit command uses the following syntax in the interactive mode:
exit

Note: Use this command in the pmcmd interactive mode only.

disconnect

191

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 interactive mode:
getrunningsessionsdetails

The following table describes pmcmd getrunningsessionsdetails options and arguments:

192

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

Chapter 5: pmcmd Command Reference

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 interactive mode:
getservicedetails
[-all|-running|-scheduled]

The following table describes pmcmd getservicedetails options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

getservicedetails

193

Option

Argument

Description

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-all
-running
-scheduled

n/a

Optional. Specifies the workflows to return details for:

- all. Returns status details on the scheduled and running
workflows.
- running. Returns status details on active workflows.
Active workflows include running, suspending, and
suspended workflows.
- scheduled. Returns status details on the scheduled
workflows.
Default is all.

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

Operating mode for the Integration Service

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

The following table describes pmcmd getserviceproperties options and arguments:

194

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

Chapter 5: pmcmd Command Reference

getsessionstatistics
Returns session details and statistics. The command returns the following information:

Folder name, workflow name, worklet or session instance, and mapping name

Session log file name and location

Number of source and target success and failure rows

Number of transformation errors

First error code and error message

Task run status

Name of associated Integration Service

Grid and node names where the session runs

The command also returns the following information for each partition:

Partition name

For each transformation within a partition: transformation instance, transformation name, number of
applied, affected, and rejected rows, throughput, last error code, start and end time

The getsessionstatistics command uses the following syntax in the interactive mode:
getsessionstatistics
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
<-workflow|-w> workflow
taskInstancePath

The following table describes pmcmd getsessionstatistics options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

getsessionstatistics

195

Option

Argument

Description

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Required if you use LDAP authentication. Optional in

command line mode. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the task name is not unique in the repository.

Name of the folder containing the task.

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task.

Use this option if you are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance that contains the task. Use this option if you are
running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

-workflow
-w

workflow

Required. Name of the workflow.

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.

gettaskdetails
Returns the following information about a task:

Folder name, workflow name, task instance name, and task type

Last execution start and complete time

Task run status, first error code, and error message

Grid and node names where the task runs

Name of associated Integration Service

Task run mode

If the task is a session, the command also returns the following details:

196

Mapping and session log file name

First error code and message

Source and target success and failed rows

Number of transformation errors

Chapter 5: pmcmd Command Reference

The gettaskdetails command uses the following syntax in the interactive mode:
gettaskdetails
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
taskInstancePath

The following table describes pmcmd gettaskdetails options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the task name is not unique in the repository.

Name of the folder containing the task.

-workflow
-w

workflow

Required if the task name is not unique in the repository.

Name of the folder containing the task.

gettaskdetails

197

Option

Argument

Description

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task.

Use this option if you are running concurrent workflows.

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.

getworkflowdetails
Returns the following information about a workflow:

Folder and workflow names

Workflow run status

First error code and error message

Start and end times

Log file name

Workflow run type

Name of user that last ran the workflow

Name of associated Integration Service

The getworkflowdetails command uses the following syntax in the interactive mode:
getworkflowdetails
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

The following table describes pmcmd getworkflowdetails options and arguments:

198

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-runinsname
-rin

runInsName

Name of the workflow run instance. Use this option if you

are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance. Use this option if you are running concurrent
workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

n/a

workflow

Name of the workflow.

help
Returns the syntax for the command you specify. If you omit the command name, pmcmd lists all commands
and their syntax.
The help command uses the following syntax in the command line mode:
pmcmd help [command]

The help command uses the following syntax in the interactive mode:
help [command]

The following table describes the pmcmd help option and argument:
Option

Argument

Description

n/a

command

Optional. Name of command. If you omit the command

name, pmcmd lists all commands and their syntax.

help

199

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

The following table describes pmcmd pingservice options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

recoverworkflow
Recovers suspended workflows. To recover a workflow, specify the folder and workflow name. The Integration
Service recovers the workflow from all suspended and failed worklets and all suspended and failed Command,
Email, and Session tasks.
The recoverworkflow command uses the following syntax in the command line mode:
pmcmd recoverworkflow
<<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
<<-user|-u> username|<-uservar|-uv> userEnvVar>
<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

The recoverworkflow command uses the following syntax in the interactive mode:
recoverworkflow
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

200

Chapter 5: pmcmd Command Reference

The following table describes pmcmd recoverworkflow options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-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
-lpf

localparamfile

Optional. Specifies the parameter file on a local machine

that pmcmd uses when you start a workflow.

-wait
-nowait

n/a

Optional. Configures the wait mode:

-runinsname
-rin

runInsName

Name of the workflow run instance you want to recover.

Use this option if you are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance you want to recover. Use this option if you are
running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

n/a

workflow

Required. Name of the workflow.

recoverworkflow

201

The scheduleworkflow command uses the following syntax in the interactive mode:
scheduleworkflow
[<-folder|-f> folder]
workflow

The following table describes pmcmd scheduleworkflow options and arguments:

202

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

n/a

workflow

Required. Name of the workflow.

Chapter 5: pmcmd Command Reference

setfolder
Designates a folder as the default folder in which to execute all subsequent commands. After issuing this
command, you do not need to enter a folder name for workflow, task, and session commands. If you enter a
folder name in a command after the setfolder command, that folder name overrides the default folder name for
that command only.
The setfolder command uses the following syntax in the interactive mode:
setfolder folder

Note: Use this command in the pmcmd interactive mode only.

The following table describes pmcmd setfolder option and argument:

Option

Argument

Description

n/a

folder

Required. Name of the folder.

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.
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
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.
The setwait command runs pmcmd in wait mode. The pmcmd prompt is available after the Integration Service
completes the previous command.
The setwait command uses the following syntax in the interactive mode:
setwait

Note: Use this command in the pmcmd interactive mode only.

setfolder

203

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

Note: Use this command in the pmcmd interactive mode only.

The following table describes pmcmd starttask options and arguments:

204

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-workflow
-w

workflow

Required. Name of the workflow.

-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.

-wait
-nowait

n/a

Optional. Configures the wait mode:

-recovery
-norecovery

n/a

Optional. If the task is a session, runs the session based

on the configured recovery strategy.
- recovery. Recovers a session.
- norecovery. Restarts a session without recovery.

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task

you want to start. Use this option if you are running
concurrent workflows.

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.

Using Parameter Files with starttask

When you start a task, you can optionally enter the directory and name of a parameter file. The Integration
Service runs the task using the parameters in the file you specify.
For UNIX shell users, enclose the parameter file name in single quotes:
-paramfile '$PMRootDir/myfile.txt'

For Windows command prompt users, the parameter file name cannot have beginning or trailing spaces. If the
name includes spaces, enclose the file name in double quotes:
-paramfile "$PMRootDir\my file.txt"

starttask

205

When you write a pmcmd command that includes a parameter file located on another machine, use the
backslash (\) with the dollar sign ($). This ensures that the machine where the variable is defined expands the
process variable.
pmcmd starttask -sv MyIntService -d MyDomain -uv USERNAME -pv PASSWORD -f east -w
wSalesAvg -paramfile '\$PMRootDir/myfile.txt' taskA

The startworkflow command uses the following syntax in the interactive mode:
pmcmd startworkflow
[<-folder|-f> folder]
[<-startfrom> taskInstancePath [<-recovery|-norecovery>]]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[<-osprofile|-o> osProfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
workflow

The following table describes pmcmd startworkflow options and arguments:

206

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-startfrom

taskInstancePath

Optional. Starts a workflow from a specified task,

taskInstancePath. If the task is within a workflow, enter
the task name alone. If the task is within a worklet, enter
WorkletName.TaskName. Enter the taskInstancePath as
a fully qualified string.
If you do not specify a starting point, the workflow starts
at the Start task.
If the task is a session, specify -recovery or -norecovery
option to run the session based on the configured
recovery strategy.

-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
-norecovery

n/a

If the task is a session, runs the session based on the

configured recovery strategy.
recovery. Recovers a session.
norecovery. Restarts a session without recovery.

-localparamfile
-lpf

localparamfile

Optional. Specifies the parameter file on a local machine

that pmcmd uses when you start a workflow.

-osprofile
-o

osProfile

Optional. Specifies the operating system profile assigned

to the workflow.

-wait
-nowait

n/a

Optional. Configures the wait mode:

-runinsname
-rin

runInsName

Name of the workflow run instance you want to start. Use

this option if you are running concurrent workflows.

n/a

workflow

Required. Name of the workflow.

Using Parameter Files with startworkflow

When you start a workflow, you can optionally enter the directory and name of a parameter file. The
Integration Service runs the workflow using the parameters in the file you specify. For UNIX shell users, enclose
the parameter file name in single quotes. For Windows command prompt users, the parameter file name cannot
have beginning or trailing spaces. If the name includes spaces, enclose the file name in double quotes.
Use parameter files on the following machines:

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.
startworkflow

207

On UNIX, use the following syntax:

-paramfile '$PMRootDir/myfile.txt'

On Windows, use the following syntax:

-paramfile "$PMRootDir\my file.txt"

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

On Windows, use the following syntax:

-lpf param_file.txt
-lpf "c:\Informatica\parameterfiles\param file.txt
-localparamfile param_file.txt

Shared network drives. When you use a parameter file located on another machine, use the backslash (\)
with the dollar sign ($). This ensures that the machine where the variable is defined expands the process
variable.
-paramfile '\$PMRootDir/myfile.txt'

The stoptask command uses the following syntax in the interactive mode:
pmcmd stoptask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath

The following table describes pmcmd stoptask options and arguments:

208

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-workflow
-w

workflow

Required. Name of the workflow.

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task

you want to stop. Use this option if you are running
concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance that contains the task you want to stop. Use this
option if you are running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

-wait
-nowait

n/a

Optional. Configures the wait mode:

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.

stoptask

209

The stopworkflow command uses the following syntax in the interactive mode:
pmcmd stopworkflow
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
workflow

The following table describes pmcmd stopworkflow options and arguments:

210

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-runinsname
-rin

runInsName

Name of the workflow run instance you want to stop. Use

this option if you are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance you want to stop. Use this option if you are
running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

-wait
-nowait

n/a

Optional. Configures the wait mode:

n/a

workflow

Required. Name of the workflow.

The unscheduleworkflow command uses the following syntax in the interactive mode:
unscheduleworkflow
[<-folder|-f> folder]
workflow

The following table describes pmcmd unscheduleworkflow options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

unscheduleworkflow

211

Option

Argument

Description

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

n/a

workflow

Required. Name of the workflow.

unsetfolder
Removes the designation of a default folder. After you issue this command, you must specify a folder name each
time you enter a command for a session, workflow, or task.
The unsetfolder command uses the following syntax in the interactive mode:
unsetfolder

Note: Use this command in the pmcmd interactive mode only.

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

212

Chapter 5: pmcmd Command Reference

userSecuritydomainEnvVar>]
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
taskInstancePath

The waittask command uses the following syntax in the interactive mode:
waittask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
taskInstancePath

The following table describes pmcmd waittask options and arguments:

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the task name is not unique in the repository.

Name of the folder containing the task.

-workflow
-w

workflow

Required. Name of the workflow.

-runinsname
-rn

runInsName

Name of the workflow run instance that contains the task.

Use this option if you are running concurrent workflows.

waittask

213

Option

Argument

Description

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance that contains the task. Use this option if you are
running concurrent workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

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.

waitworkflow
Causes pmcmd to wait for a workflow to complete before it executes subsequent commands. Use this command
in conjunction with the return code when you run pmcmd from a script. For example, you may want to check
the status of a critical workflow before starting another workflow. Use the waitworkflow command to wait for
the critical workflow to complete, and then check the pmcmd return code. If the return code is 0 (successful),
start the next workflow.
The waitworkflow command returns the prompt when a workflow completes.
The waitworkflow command uses the following syntax in the command line mode:
pmcmd waitworkflow
<<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
<<-user|-u> username|<-uservar|-uv> userEnvVar>
<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

The waitworkflow command uses the following syntax in the interactive mode:
waitworkflow
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow

The following table describes pmcmd waitworkflow options and arguments:

214

Option

Argument

Description

-service
-sv

service

Required. Integration Service name.

-domain
-d

domain

Optional. Domain name.

-timeout
-t

timeout

Optional. Amount of time, in seconds, pmcmd attempts to

Chapter 5: pmcmd Command Reference

Option

Argument

Description

-user
-u

username

Required in command line mode if you do not specify the

user name environment variable. User name. Not used in
interactive mode.

-uservar
-uv

userEnvVar

Specifies the user name environment variable.

Required in command line mode if you do not specify the
user name. Not used in interactive mode.

-password
-p

password

Required in command line mode if you do not specify the

password environment variable. Password. Not used in
interactive mode.

-passwordvar
-pv

passwordEnvVar

Required in command line mode if you do not specify the

password. Password environment variable. Not used in
interactive mode.

-usersecuritydomain
-usd

usersecuritydomain

Optional in command line mode. Required if you use

LDAP authentication. Name of the security domain that
the user belongs to. Not used in interactive mode. Default
is Native.

-usersecuritydomainvar
-usdv

userSecuritydomain
EnvVar

Optional in command line mode. Security domain

environment variable. Not used in interactive mode.

-folder
-f

folder

Required if the workflow name is not unique in the

repository. Name of the folder containing the workflow.

-runinsname
-rin

runInsName

Name of the workflow run instance. Use this option if you

are running concurrent workflows.

-wfrunid

workflowRunId

Run identifier number (Run ID) of the workflow run

instance. Use this option if you are running concurrent
workflows.
Note: Use this option if the workflow does not have a
unique run instance name.

n/a

workflow

Required. Name of the workflow.

waitworkflow

215

216

Chapter 5: pmcmd Command Reference

CHAPTER 6

pmrep Command Reference

This chapter includes the following topics:

Using pmrep, 217

Syntax and descriptions for the pmrep commands

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.
For more information about performing pmrep tasks through the user interface, see the PowerCenter Repository
Guide.
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 user names and passwords for pmrep. Before you use pmrep, configure
these variables. The environment variables apply to pmrep commands that run on the node.
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.
Note: If the domain is a mixed-version domain, run pmrep from the installation directory of the Repository
Service version.

Running Commands in Command Line Mode

Command line mode invokes and exits pmrep each time you issue a command. Command line mode is useful if
you want to run pmrep commands through batch files, scripts, or other programs.

217

To run pmrep commands in command line mode:

At the command prompt, change to the directory where the pmrep executable is located.

Enter pmrep followed by the command name and its options and arguments:
pmrep command_name [-option1] argument_1 [-option2] argument_2...

Running Commands in Interactive Mode

Interactive mode invokes pmrep. You can issue a series of commands from a pmrep prompt without exiting after
each command.
To run pmrep commands in interactive mode:
1.

At the command prompt, enter pmrep to invoke interactive mode.

This starts pmrep in interactive mode and displays a pmrep> prompt. You do not have to type pmrep before
each command in interactive mode.

Enter a command and its options and arguments.

At the prompt, enter:
command_name [-option1] argument_1 [-option2] argument_2...

pmrep runs the command and displays the prompt again.

Type exit to end an interactive session.

Running Commands in Normal Mode and Exclusive Mode

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

Create

Delete

RegisterPlugin

Unregister

UnregisterPlugin

You can use the Administration Console or infacmd to run the Repository Service in exclusive mode.

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. Some commands perform multiple
operations. For example, AddToDeploymentgroup adds multiple objects to a deployment group. In these cases,
a Return code 0 indicates that the command was executed successfully even if only some of the objects were
deployed successfully.
Enter one of the following DOS or UNIX echo commands immediately after running the pmrep command:

218

In a DOS shell, enter echo %ERRORLEVEL%

In a UNIX Bourne or Korn shell, enter echo $?

In a UNIX C shell, enter echo $status

Chapter 6: pmrep Command Reference

Using Native Connect Strings

Some pmrep commands, such as CreateConnection and Restore, require a native connect string.
Table 6-1 describes the native connect string syntax for each supported repository database:
Table 6-1. Native Connect String Syntax
Database

Connect String Syntax

Example

IBM DB2

dbname

mydatabase

Microsoft SQL Server

servername@dbname

sqlserver@mydatabase

Oracle

dbname.world (same as TNSNAMES entry)

oracle.world

Sybase ASE

servername@dbname

sambrown@mydatabase

Scripting pmrep Commands

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

You can run script files from the command interface. You cannot run pmrep batch files in interactive mode.

Tips
Use the following tips when you create and run pmrep scripts:

Include a Connect command as the first command called by the script file. This helps ensure that you
perform tasks on the correct repository.

To run pmrep scripts that connect to different repositories simultaneously, set the INFA_REPCNX_INFO
environment variable in each environment to store the name and file path for the repository connection file.
This prevents a script from overwriting the connection information used by another script.

AddToDeploymentGroup
Adds objects to a deployment group. Use AddToDeploymentGroup to add source, target, transformation,
mapping, session, worklet, workflow, scheduler, session configuration, and task objects.
You cannot add checked out objects to a deployment group. You can specify objects using command options or
you can use a persistent input file. If you use a persistent input file, you can enter the deployment group name
option.
Use AddToDeploymentGroup to add reusable input objects. If you want to add non-reusable input objects, you
must use a persistent input file that contains encoded object IDs.

AddToDeploymentGroup

219

If AddToDeploymentGroup runs successfully, it either sends back no status information, or it returns a list of
objects that are already in the deployment group. If the command fails, it displays the reason for failure.
The AddToDeploymentGroup command uses the following syntax:
addtodeploymentgroup
-p <deployment_group_name>
{{-n <object_name>
-o <object_type>
-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>]} |
[-i <persistent_input_file>]}
[-d <dependency_types (all, "non-reusable", or none)>]

The following table describes pmrep AddToDeploymentGroup options and arguments:

Option

Argument

Description

-p

deployment_group_name

Required. Name of the deployment group to add objects to.

-n

object_name

Required when you add a specific object. Name of the object you
are adding to the deployment group. You cannot enter the name of
a checked out object. You cannot use the -n option if you use the -i
option.

-o

object_type

Required when adding a specific object. Type of object you are

adding. You can specify source, target, transformation, mapping,
session, worklet, workflow, scheduler, session configuration, task,
cube, and dimension.

-t

object_subtype

Required when using valid subtypes. Type of task or

transformation you are adding. For valid subtypes, see Table 6-6
on page 246.

-v

version_number

Optional. Version of the object to add. Default is the latest version

of the object. The command fails if you specify a version number
for a non-versioned repository.

-f

folder_name

Required when you enter an object name. Folder that contains the
object you are adding.

-i

persistent_input_file

A text file generated from ExecuteQuery, Validate, or

ListObjectDependencies that contains a list of object records with
encoded IDs. If you use this parameter, pmrep does not allow the
-n, -o, and -f options.

-d

dependency_types

Optional. Dependent objects to add to the deployment group with

the object. Enter one of the following:
- all. pmrep adds the objects and all dependent objects, reusable
and non-reusable, to the deployment group.
- non-reusable. pmrep adds the objects and the corresponding
non-reusable dependent objects to the deployment group.
- none. pmrep does not add dependent objects to the deployment
group.
If you omit this parameter, pmrep adds the objects and all
dependent objects to the deployment group.
Note: Use double quotes around arguments that contain spaces or
non-alphanumeric characters.

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.
220

Chapter 6: pmrep Command Reference

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.
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.
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>]

The following table describes pmrep ApplyLabel options and arguments:

Option

Argument

Description

-a

label_name

Required. Label name to apply to the object.

-n

object_name

Required if you are updating a specific object. Name of the object

to receive the label. You cannot enter object names if you use the -i
option.

-o

object_type

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.

-t

object_subtype

Required. Type of task or transformation you are labeling. pmrep

Optional. Comments about the label.

AssignPermission
Allows you to add, remove, or update permissions on a global object for a user, group, or the Others default
group.
Note: Only the administrator or the current owner of the object can manage permissions on the object.

The AssignPermission command uses the following syntax:

AssignPermission
-o <object_type>
[-t <object_subtype>]
-n <object_name>
{-u <user_name> | -g <group_name>}
[-s <security_domain>]
-p <permission>

The following table describes pmrep AssignPermission options and arguments:

222

Option

Argument

Description

-o

object_type

Required. Type of the object for which you want to manage

permissions. You can specify folder, label, deploymentgroup,
query, or connection.

-t

object_subtype

Optional. Type of connection object or query. Not required for other

object types. For valid subtypes, see Table 6-2 on page 223.

-n

object_name

Required. Name of the object for which you want to manage

permissions.

-u

user_name

Required if you do not use the -g option. Name of the user for
whom you want to add, remove, or update permissions. Use the -u
or -g option, not both.

-g

group_name

Name of the group for which you want to add, remove, or update
permissions. Specify Others as the group name to change
permissions for the Others default group.
Use the -u or -g option, but not both.

-s

security_domain

Required if you use LDAP authentication. Name of the security

domain that the user or group belongs to. Default is Native.

-p

permission

Required. Permissions you want to add, remove, or update. You

assign read, write and execute permission on a global object. Use
the characters r, w, and x to assign read, write, and execute
permissions.

Chapter 6: pmrep Command Reference

Table 6-2 describes the object types and values to use with pmrep commands:
Table 6-2. Query and Connection Subtypes
Object Type

Object Subtype

Query

Shared

Query

Personal

Connection

Application

Connection

FTP

Connection

Loader

Connection

Queue

Connection

Relational

Example
You can add, remove, or update permissions with the -p option.
For example, to add read and write permissions on a folder, enter the following text at the prompt:
pmrep AssignPermission -o folder -n Sales -u Admin -p rw

You can also update permissions on an object. For example, you assigned permission to read on a folder and
need to include permission to write. To update permissions, enter the following text at the prompt:
pmrep AssignPermission -o folder -n Sales -u Admin -p rw

To remove all permissions, enter the following text at the prompt:

pmrep AssignPermission -o folder -n Sales -u Admin -p ""

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.
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)]

The following table describes pmrep BackUp options and arguments:

Option

Argument

Description

-o

output_file_name

Required. Name and path of the file for the repository backup. When you
view the list of repository backup files in the Administration Console, you
can see only files with an extension of .rep.

-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.

-f

n/a

Optional. Overwrites an existing file with the same name.

BackUp

223

Option

Argument

Description

-b

n/a

Optional. Skips tables related to workflow and session logs during backup.

-j

n/a

Optional. Skips deployment group history during backup.

-q

n/a

Optional. Skips tables related to MX data during backup.

-v

n/a

Optional. Skips task statistics during backup.

To restore the backup file, use the Administration Console, or use the pmrep Restore command.

ChangeOwner
Changes the owner name for a global object.
Note: Only the administrator or current owner of the object have the permission to change ownership for an

object.
The ChangeOwner command uses the following syntax:
ChangeOwner
-o <object_type>
[-t <object_subtype>]
-n <object_name>
-u <new_owner_name>
[-s <security_domain>]

The following table describes pmrep ChangeOwner options and arguments:

Option

Argument

Description

-o

object_type

Required. Type of the object. You can specify folder, label,

deploymentgroup, query, or connection.

-t

object_subtype

Optional. Type of object query or connection object. Not required for other
object types. For valid subtypes, see Table 6-2 on page 223.

-n

object_name

Required. Name of the object.

-u

new_owner_name

Required. Name of the changed owner. The changed owner name must
be a valid user account in the domain.

-s

security_domain

Required if you use LDAP authentication. Name of the security domain

that the new owner belongs to. Default is Native.

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.
The CheckIn command uses the following syntax:
checkin
-o <object_type>
[-t <object_subtype>]
-n <object_name>
-f <folder_name>
[-c <comments>]

224

Chapter 6: pmrep Command Reference

The following table describes pmrep CheckIn options and arguments:

Option

Argument

Description

-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-6 on page 246.

-n

object_name

Required. Name of the object that you are checking in.

-f

folder_name

Required. Folder to contain the new object version.

-c

comments

Optional. Comments about the check in.

CleanUp
Cleans up any persistent resource created by pmrep. This command also cleans up any connection information
from previous sessions of pmrep. Calling CleanUp as the first command in a session always returns an error.
If you call CleanUp in the interactive mode, pmrep disconnects any repository you are connected to.
The CleanUp command uses the following syntax:
cleanup

ClearDeploymentGroup
Clears all objects from a deployment group. Use this command to retain the deployment group but remove the
objects.
The ClearDeploymentGroup command uses the following syntax:
cleardeploymentgroup
-p <deployment_group_name>
[-f (force clear)]

The following table describes pmrep ClearDeploymentGroup options and arguments:

Option

Argument

Description

-p

deployment_group_name

Required. Name of the deployment group that you want to clear.

-f

n/a

Optional. Remove objects without confirmation. If you omit this

argument, the command prompts you for a confirmation before it
clears the objects.

Connect
Connects to a repository. The first time you use pmrep in either command line or interactive mode, you must
use the Connect command. All commands require a connection to the repository except for the following
commands:

Exit
CleanUp

225

Help

ListAllPrivileges

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

Table 6-3 describes pmrep Connect options and arguments:

Table 6-3. Connect Options and Arguments

226

Option

Argument

Description

-r

repository_name

Required. Name of the repository you want to connect to.

-d

domain_name

Required if you do not use -h and -o. Name of the domain for the
repository. If you use the -d option, do not use the -h and -o options.

-h

portal_host_name

Required if you do not use -d. If you use the -h option, then you must
also use the -o option. Gateway host name.

-o

portal_port_number

Required if you do not use -d. If you use the -o option, then you must
also use the -h option. Gateway port number.

-n

user_name

Optional. User name used to connect to the repository.

-s

user_security_domain

Required if you use LDAP authentication. Name of the security domain

that the user belongs to. Default is Native.

-x

password

Required if you use the -n option and you do not use the -X option.
Password for the user name. The password is case sensitive. Use the
-x or -X option, but not both.

-X

password_
environment_variable

Required if you use the -n option and you do not use the -x option.
Password environment variable. Use the -x or -X option, but not both.

-t

client_resilience

Optional. Amount of time in seconds that pmrep attempts to establish

or reestablish a connection to the repository. If you omit the -t option,
pmrep uses the timeout value specified in the
INFA_CLIENT_RESILIENCE_TIMEOUT environment variable. If no
value is specified in the environment variable, the default of 180
seconds is used.

Chapter 6: pmrep Command Reference

Create
Creates the repository tables in the database. Before you can create the repository tables, you must complete
these tasks:

Create and configure the database to contain the repository.

Create the Repository Service in either the Administration Console or infacmd.

Run the Repository Service in exclusive mode in either the Administration Console or infacmd.

Connect to the repository in pmrep.

You cannot use the Create command if the repository database already contains repository tables.
To use the Create command, you must have permission on the Repository Service in the domain.
The Create command uses the following syntax:
create
-u <domain_user_name>
[-s <domain_user_security_domain>]
[-p <domain_password> |
-P <domain_password_environment_variable>]
[-g (create global repository)]
[-v (enable object versioning)]

The following table describes pmrep Create options and arguments:

Option

Argument

Description

-u

domain_user_name

Required. User name.

-s

domain_user_security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-p

domain_password

Optional. Password. Use either the -p or -P option, but not

both. If you do not use either the -p or -P option, pmrep
prompts you to enter the password.

-P

domain_password_
environment_variable

Optional. Password environment variable. Use either the -p or

-P option, but not both. If you do not use either the -p or -P
option, pmrep prompts you to enter the password.

-g

n/a

Optional. Promotes the repository to a global repository.

-v

n/a

Optional Enables object versioning for the repository.

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.
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)]

Create

227

[-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)]

The following table describes pmrep CreateConnection options and arguments:

228

Option

Argument

Description

-s

connection_type

Required. Type of connection. For valid database types, see Table 6-4
on page 229. For example, to create a Salesforce connection, use the
following syntax:
-s "salesforce connection"

-n

connection_name

Required Name of the connection.

-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.

-P

password_
environment_variable

Optional. Password environment variable used for authentication when

you connect to the relational database. Use the -p or -P option, but not
both. If you do not use the -p or -P option, pmrep prompts you for the
password.

-c

connect_string

Connect string the Integration Service uses to connect to the relational

database. For native connect strings, see Table 6-1 on page 219.

-l

code_page

Required. Code page associated with the connection. For valid code
page values, see Specifying the Database Code Page on page 231.

-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_
environment_sql

Optional. Enter SQL commands to set the database environment when

you connect to the database. The Integration Service executes the
connection environment SQL each time it connects to the database.

-f

transaction_
environment_sql

Optional. Enter SQL commands to set the database environment when

you connect to the database. The Integration Service executes the
transaction environment SQL at the beginning of each transaction.

-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.

Chapter 6: pmrep Command Reference

Option

Argument

Description

-a

data_source_name

Optional Teradata ODBC data source name. Valid for Teradata

connections.

-x

n/a

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.

-k

connection_attributes

Enables user-defined connection attributes. Attributes have the format

<name>=<value>;<name>=<value>; and so on.

Specifying the Database Type

When you create a connection, you must enter a database type using the string associated with that database
type in pmrep. The strings are not case sensitive. Use quotes when entering a string with spaces in an argument.
Table 6-4 describes the required pmrep database type strings according to database:
Table 6-4. Database Type Strings
Database

Database Type String

HTTP Transformation

Http Transformation

IBM DB2 for Linux, UNIX, and Windows

DB2

Informix

JMS

JMS Connection

JNDI

JNDI Connection

LMAPI Target

LMAPITarget

Microsoft SQL Server

ODBC

Oracle

PeopleSoft DB2

PeopleSoft Informix

PeopleSoft MS SQL Server

PeopleSoft MsSqlserver

PeopleSoft Oracle

PeopleSoft Sybase

PowerChannel for DB2

PowerChannel for MS SQL Server

PowerChannel for ODBC

PowerChannel for Oracle

DB2 for i5/OS, PowerExchange bulk data

movement

PWX DB2i5OS

DB2 for i5/OS, PowerExchange change data

capture

PWX DB2i5OS CDC Change

DB2 for i5/OS, PowerExchange change data

capture

PWX DB2i5OS CDC Real Time

DB2 for Linux, UNIX, and Windows,

PowerExchange bulk data movement

PWX DB2LUW

DB2 for Linux, UNIX, and Windows,

PowerExchange change data capture

PWX DB2LUW CDC Change

CreateConnection

229

Table 6-4. Database Type Strings

230

Database

Database Type String

DB2 for Linux, UNIX, and Windows,

PowerExchange change data capture

PWX DB2LUW CDC Real Time

DB2 for z/OS, PowerExchange bulk data

movement

PWX DB2zOS

DB2 for z/OS, PowerExchange change data

capture

PWX DB2zOS CDC Change

DB2 for z/OS, PowerExchange change data

capture

PWX DB2zOS CDC Real Time

Microsoft SQL Server, PowerExchange bulk

data movement

PWX MSSQLServer

Microsoft SQL Server, PowerExchange

change data capture

PWX MSSQL CDC Change

Microsoft SQL Server, PowerExchange

change data capture

PWX MSSQL CDC Real Time

Nonrelational, PowerExchange bulk data

movement

PWX NRDB Batch

Nonrelational, PowerExchange change data

capture

PWX NRDB CDC Change

Nonrelational, PowerExchange change data

capture

PWX NRDB CDC Real Time

Nonrelational Lookup, PowerExchange

PWX NRDB Lookup

Oracle, PowerExchange bulk data movement

PWX Oracle

Oracle, PowerExchange change data capture

PWX Oracle CDC Change

Oracle, PowerExchange change data capture

PWX Oracle CDC Real Time

Sybase, PowerExchange bulk data movement

PWX Sybase

Salesforce

Salesforce Connection

SAP BW

SAP BWOHS READER

SAP_BWOHS_READER

SAP R3

SAP RFC/BAPI Interface

SAP/ALE IDoc Reader

SAP_ALE_IDoc_Reader

SAP/ALE IDoc Writer

SAP_ALE_IDoc_Writer

Siebel DB2

Siebel Informix

Siebel MS SQL Server

Siebel MsSqlserver

Siebel Oracle

Siebel Sybase

Sybase

Teradata

Teradata FastExport

Teradata FastExport Connection

Web Services Consumer

webMethods Broker

Chapter 6: pmrep Command Reference

Specifying the Database Code Page

The -l option specifies the code page for the database connection. Enter the code page name you want to assign
to the database connection. For example, to assign the US-ASCII code page to the database connection, enter
the code page name US-ASCII.
Changing the database connection code page can cause data inconsistencies if the new code page is not
compatible with the source or target database connection code pages. Also, if you configure the Integration
Service for data code page validation, changing the database connection code page can cause sessions to fail if
the source database connection code page is not a subset of the target database connection code page.

CreateDeploymentGroup
Creates a deployment group. You can create a dynamic or static deployment group. To create a dynamic
deployment group, you must supply a query name, and indicate whether the query is private or public.
The CreateDeploymentGroup command uses the following syntax:
createdeploymentgroup
-p <deployment_group_name>
[-t <deployment_group_type (static or dynamic)>]
[-q <query_name>]
[-u <query_type (shared or personal)>]
[-c <comments>]

The following table describes pmrep CreateDeploymentGroup options and arguments:

Option

Argument

Description

-p

deployment_group_name

Required. Name of the deployment group to create.

-t

deployment_group_type

Optional. Create a static group or use a query to dynamically create

the group. You can specify static or dynamic. Default is static.

-q

query_name

Required if the deployment group is dynamic, but ignored if the

group is static. Name of the query associated with the deployment
group.

-u

query_type

Required if the deployment group is dynamic, but ignored if the

group is static. Type of query to create a deployment group. You can
specify shared or personal.

-c

comments

Optional. Comments about the new deployment group.

CreateFolder
Creates a folder in the repository.
The CreateFolder command uses the following syntax:
createfolder
-n <folder_name>
[-d <folder_description>]
[-o <owner_name>]
[-a <owner_security_domain>]
[-s (shared_folder)]
[-p <permissions>]
[-f <active | frozendeploy | frozennodeploy>]

CreateDeploymentGroup

231

The following table describes pmrep CreateFolder options and arguments:

Option

Argument

Description

-n

folder_name

Required. Folder name.

-d

folder_description

Optional. Description of the folder that appears in the Repository

Manager. If the folder description contains spaces or other
non-alphanumeric characters, enclose it in quotation marks.

-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.

-a

owner_security_domain

Required if you use LDAP authentication. Name of the security

domain that the owner belongs to. Default is Native.

-s

n/a

Optional. Makes the folder shared.

-p

permissions

Optional. Access rights for the folder. If omitted, the Repository

Service assigns default permissions.

-f

active
frozendeploy
frozennodeploy

Optional. Changes the folder status to one of the following statuses:

- 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.

Note: You can add, remove, or update permissions on a folder by using the AssignPermission command. For
more information, see AssignPermission on page 222.

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.
Enter one number for each set of permissions. Each permission is associated with a number. Designate 4 for
read permission, 2 for write permission, and 1 for execute permission. To assign permissions, you enter 4, 2, 1,
or the sum of any of those numbers.
For example, if you want to assign default permissions, use the following command syntax:
-p 764

This gives the folder owner read, write, and execute permissions (7 = 4+2+1). The owners group has read and
write permissions (6 = 4+2). All others have read permission.
The command returns createfolder successfully completed or returns createfolder failed message. The
creation might fail for the following reasons:

The folder already exists.

The owner does not exist or does not belong to the group.

CreateLabel
Creates a label that you use to associate groups of objects during development. You can associate a label with
any versioned object or group of objects in a repository.

232

Chapter 6: pmrep Command Reference

The CreateLabel command uses the following syntax:

createlabel
-a <label_name>
[-c <comments>]

The following table describes pmrep CreateLabel options and arguments:

Option

Argument

Description

-a

label_name

Required. Name of the label you are creating.

-c

comments

Optional. Comments about the label.

Delete
Deletes the repository tables from the repository database.
Before you use the Delete command, you must connect to the repository and provide a user name and password
or password environment variable.
When you use the Delete command, the Repository Service must be running in exclusive mode. You can
configure the Repository Service to run in exclusive mode in the Administration Console or you can use the
infacmd UpdateRepositoryService command.
The Delete command uses the following syntax:
delete
[-x <repository_password_for_confirmation> |
-X <repository_password_environment_variable_for_confirmation>]
[-f (forceful delete: unregisters local repositories and deletes)]

The following table describes pmrep Delete options and arguments:

Option

Argument

Description

-x

repository_password_for_
confirmation

Optional. Password. You can use the -x or -X option, but not both.
If you do not use the -x or -X option, pmrep prompts you to enter
the password for confirmation.

-X

repository_password_
environment_variable_for_
confirmation

Optional. Password environment variable. You can use the -x or

-X option, but not both. If you do not use the -x or -X option,
pmrep prompts you to enter the password for confirmation.

-f

n/a

Optional. Deletes a global repository and unregisters local

repositories. All registered local repositories must be running.

DeleteConnection
Deletes a relational connection from the repository.
The DeleteConnection command uses the following syntax:
deleteconnection
-n <connection_name>
[-f (force delete)]
[-s <connection type application, relational, ftp, loader or queue>]

Delete

233

The following table describes pmrep DeleteConnection options and arguments:

Option

Argument

Description

-n

connection_name

Required. Name of the connection to delete.

-f

n/a

Optional. Connection will be deleted without further confirmation.

-s

connection type
application, relational, ftp,
loader or queue

Optional. Type of connection. A connection can be one of the

following types:
- Application
- FTP
- Loader
- Queue
- Relational
Default is relational.

DeleteDeploymentGroup
Deletes a deployment group. If you delete a static deployment group, you also remove all objects from the
deployment group.
The DeleteDeploymentGroup command uses the following syntax:
deletedeploymentgroup
-p <deployment_group_name>
[-f (force delete)]

The following table describes pmrep DeleteDeploymentGroup options and arguments:

Option

Argument

Description

-p

deployment_group_name

Required. Name of the deployment group to delete.

-f

n/a

Optional. Deletes the deployment group without confirmation. If you

omit this argument, pmrep prompts you for a confirmation before it
deletes the deployment group.

DeleteFolder
Deletes a folder from the repository.
The DeleteFolder command uses the following syntax:
deletefolder
-n <folder_name>

The following table describes pmrep DeleteFolder option and argument:

234

Option

Argument

Description

-n

folder_name

Required. Name of the folder.

Chapter 6: pmrep Command Reference

DeleteLabel
Deletes a label and removes the label from all objects that use it. If the label is locked, the delete fails.
The DeleteLabel command uses the following syntax:
deletelabel
-a <label_name>
[-f (force delete)]

The following table describes pmrep DeleteLabel options and arguments:

Option

Argument

Description

-a

label_name

Required. Name of the label to delete.

-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.

DeleteObject
Deletes an object. Use DeleteObject to delete a source, target, user-defined function, mapplet, mapping,
session, worklet or workflow.
The DeleteObject command uses the following syntax:
DeleteObject
-o <object_type>
-f <folder_name>
-n <object_name>

The following table describes pmrep DeleteObject options and arguments:

Option

Argument

Description

-o

object_type

Required Type of the object you are deleting: source, target, mapplet,
mapping, session, user defined function, worklet, workflow.

-f

folder_name

Required Name of the folder that contains the object.

-n

object_name

Required. Name of the object you are deleting. If you delete a source definition
you must prepend the database name. For example, DBD.sourcename.

Note: You can run the DeleteObject command against a non-versioned repository. If you run the DeleteObject
command against a versioned repository, pmrep returns the following error:
This command is not supported because the versioning is on for the repository <Repository
name>.
Failed to execute DeleteObject

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.
DeleteLabel

235

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.
Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire
object locks.
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>
[-s <target_repository_user_security_domain>]
[-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 differentdomain)
[-l <log_file_name>]

The following table describes pmrep DeployDeploymentGroup options and arguments:

236

Option

Argument

Description

-p

deployment_group_name

Required. Name of the group to deploy.

-c

control_file_name

Required. Name of the XML file containing the Copy Wizard

specifications. The deployment control file is required.

-r

target_repository_name

Required. Name of the target repository where you are copying

the deployment group.

-n

target_repository_user_
name

Required if you copy the deployment group to a different

repository. Login user name for the target repository.

-s

target_repository_user_
security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-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.

-X

target_repository_password_
environment_variable

Optional. Login password environment variable for the target

repository. You use the -x or -X option, but not both. If you copy
the deployment group to a different repository and you do not
use the -x or -X option, pmrep prompts you for the password.

-d

target_domain_name

Required if you copy the deployment group to a different

repository and you do not use the -h and -o options. Name of the
domain for repository.

-h

target_portal_host_name

Required if you copy the deployment group to a different

repository and you do not use the -d option. Machine name for
the node that hosts the domain of the target repository.

-o

target_portal_port_number

Required if you copy the deployment group to a different

repository and you do not use the -d option. Port number for the
node that hosts the domain of the target repository.

-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.

Chapter 6: pmrep Command Reference

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.
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.
Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire
object locks.
The DeployFolder command uses the following syntax:
deployfolder
-f <folder_name>
-c <control_file_name>
-r <target_repository_name>
[-n <target_repository_user_name>
[-s <target_repository_user_security_domain>]
[-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 differentdomain)
[-l <log_file_name>]

The following table describes pmrep DeployFolder options and arguments:

Option

Argument

Description

-f

folder_name

Required. Name of the folder to deploy.

-c

control_file_name

Required. Name of the XML file containing the Copy Wizard

specifications.

-r

target_repository_name

Required. Name of the target repository you are copying the

folder to.

-n

target_repository_user_name

Required if you copy the folder to another repository. Login user

name for the target repository.

-s

target_repository_user_
security_domain

Required if you use LDAP authentication. Name of the security

domain that the user belongs to. Default is Native.

-x

target_repository_user_
password

Optional. Login password for the target repository. Use the -x or

-X option, but not both. If you copy the folder to a different
repository and you do not use the -x or -X option, pmrep prompt
you for the password.

-X

target_repository_password_
environment_variable

Optional. Login password environment variable for the target

repository. Use the -x or -X option, but not both. If you copy the
folder to a different repository and you do not use the -x or -X
option, pmrep prompt you for the password.

-d

target_domain_name

Required if you copy the folder to a different repository and you

do not use the -h and -o options. Name of the domain for the
repository.

-h

target_portal_host_name

Required if you copy the folder to a different repository and you

do not use the -d option. Machine name for the node that hosts
the domain of the target repository.

DeployFolder

237

Option

Argument

Description

-o

target_portal_port_number

Required if you copy the folder to a different repository and you

do not use the -d option. Port number for the node that hosts
the domain of the target repository.

-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.

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 the persistent input file with the ApplyLabel, AddToDeploymentGroup, MassUpdate, and Validate
commands.
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)]

The following table describes pmrep ExecuteQuery options and arguments:

238

Option

Argument

Description

-q

query_name

Required. Name of the query to run.

-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.

-c

column_separator

Optional. Character or set of characters used to separate object

metadata columns. Use a character or set of characters that is
not used in repository object names. If any repository object
name contains spaces, you might want to avoid using a space as
a column separator.
If you omit this option, pmrep uses a single space.

-r

end-of-record_separator

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. If you omit this option,
pmrep uses a new line.

Chapter 6: pmrep Command Reference

Option

Argument

Description

-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. Displays more than the minimum information

about the objects. If you omit this option, pmrep prints a shorter
format including the object type, the word reusable or
non-reusable, the object name and path. Verbose format
includes the object status, version number, folder name, and
checked out information.
The short format for global objects, such as label, query,
deployment group, and connection, includes the object type and
object name. Verbose format includes the label type, query type,
deployment group type, creator name, and creation time.

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

FindCheckout
Displays a list of checked out objects in the repository. The listing contains the checked-out items unless you
enter all users.
If you choose an object type, then you can list checked-out objects in a specific folder or across all folders. If
you do not specify an object type, pmrep returns all the checked-out objects in the repository.
The FindCheckout command uses the following syntax:
findcheckout
[-o <object_type>]
[-f <folder_name>]
[-u (all_users)]
[-c <column_separator>]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]

The following table describes pmrep FindCheckout options and arguments:

Option

Argument

Description

-o

object_type

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

Optional if you specify an object type. 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.

Exit

239

Option

Argument

Description

-u

n/a

Optional. List the checked out objects by all users. The default is to
list checked out objects by the current user.

-c

column_separator

Optional. Character or set of characters used to separate object

metadata columns.
Use a character or set of characters that is not used in repository
object names. If any repository object name contains spaces, you
might want to avoid using a space as a column separator.
If you omit this option, pmrep uses a single space.

-r

end-of-record_separator

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. Use 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 prints a shorter
format including the object type, the word reusable or
non-reusable, the object name and path. Verbose format includes
the version number and folder name.
The short format for global objects such as label, query,
deployment group, and connection, includes the object type and
object name. Verbose format includes the creator name and
creation time.

GetConnectionDetails
Lists the properties and attributes of a connection object as name-value pairs.
To use the GetConnectionDetails command, you need read permission on the connection object.
The GetConnectionDetails command uses the following syntax:
getconnectiondetails
-n <connection_name>
-t <connection_type>

The following table describes pmrep GetConnectionDetails options and arguments:

Option

Argument

Description

-n

connection_name

Required. Name of the connection to list details for.

-t

connection_type

Required. Type of connection. A connection can be one of the following

types:
- Application
- FTP
- Loader
- Queue
- Relational

Help
Returns the syntax for the command you specify. If you do not specify a command, then syntax for all of the
pmrep commands is displayed.
240

Chapter 6: pmrep Command Reference

The Help command uses the following syntax:

help [command]

-or-help [command]

KillUserConnection
Terminates user connections to the repository. You can terminate user connections based on the user name or
connection ID. You can also terminate all user connections to the repository.
The KillUserConnection command uses the following syntax:
killuserconnection
{-i <connection_id> |
-n <user_name> |
-a (kill all)}

The following table describes pmrep KillUserConnection options and arguments:

Option

Argument

Description

-i

connection_id

Repository connection ID.

-n

user_name

User name.

-a

n/a

Terminates all connections.

ListConnections
Lists all connection objects in the repository and their respective connection types. A connection can be one of
the following types:

Application

FTP

Loader

Queue

Relational

The ListConnections command uses the following syntax:

listconnections
[-t (output includes connection subtype)]

The following table describes the pmrep ListConnections option:

Option

Argument

Description

-t

n/a

Optional. Displays the connection subtype. For example, for a Relational

connection, connection subtypes include Oracle, Sybase, and Microsoft
SQL Server. You can only view the subtype for connections that you have
read permission on.

KillUserConnection

241

ListObjectDependencies
Lists dependency objects for reusable and non-reusable objects. If you want to list dependencies for
non-reusable objects, you must use a persistent input file containing object IDs. You can create this file by
running a query and choosing to create a text file.
ListObjectDependencies accepts a persistent input file and it can create a persistent output file. These files are
the same format. If you create an output file, use it as input to the ApplyLabel, AddToDeployment Group, or
Validate pmrep commands.
ListObjectDependencies returns the number of records if the command runs successfully.
The ListObjectDependencies command uses the following syntax:
listobjectdependencies
{{-n <object_name>
-o <object_type>
[-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>] } |
-i <persistent_input_file>}
[-d <dependency_object_types>]
[-p <dependency_direction (children, parents, or both)>]
[-s (include pk-fk dependency)]
[-g (across repositories)]
[-u <persistent_output_file_name>
[-a (append)]]
[-c <column_separator]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]

The following table describes pmrep ListObjectDependencies options and arguments:

242

Option

Argument

Description

-n

object_name

Required. Name of a specific object to list dependencies for.

-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

Type of transformation or task. Ignored for other object types. For valid
subtypes, see Table 6-6 on page 246.

-v

version_number

Optional. List dependent objects for an object version other than the
latest version. You must use this option only for versioned repositories.
It does not apply to non-versioned repositories.

-f

folder_name

Folder containing object name. Folder is required if you do not use the
-i option.

-i

persistent_input_file

Optional. Text file of objects generated from ExecuteQuery or Validate

commands. You must use this file if you want to list dependencies for
non-reusable objects.
If you use this option, then you cannot use the -n, -o, -f options to
specify objects.

-d

dependency_object_
types

Optional. Type of dependent objects to list. You can enter ALL or one
or more object types. Default is ALL.
If ALL, then pmrep lists all supported dependent objects. If you choose
one or more objects, then pmrep lists dependent objects for these
types. To enter multiple object types, separate them by commas
without spaces.

-p

dependency_direction

Required if you do not use the -s option. Parents or children

dependent objects to list. You can specify parents, children, or both. If
you do not use the -p option, pmrep does not list parent or child
dependencies.

Chapter 6: pmrep Command Reference

Option

Argument

Description

-s

n/a

Required if you do not use the -p option. Include the primary

key-foreign key dependency object regardless of the direction of the
dependency. If you do not use the -s option, pmrep does not list
primary-key/foreign-key dependencies.

-g

n/a

Optional. Find object dependencies across repositories.

-u

persistent_output_file_
name

Send the dependency result to a text file. Use the text file as input to
the ApplyLabel, AddToDeployment Group, or Validate pmrep
commands. The default sends the query result to stdout. You cannot
use the -b and -c options with this option.

-a

n/a

Append the result to the persistent output file name file instead of
overwriting it.

-c

column_separator

Character or set of characters used to separate object metadata

columns. Use a character or set of characters that is not used in
repository object names. If any repository object name contains
spaces, you might want to avoid using a space as a column separator.
You cannot use this option with the -u option.
If you omit this option, pmrep uses a single space.

-r

end-of-record_
separator

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

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

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. You
cannot use this option with the -u option.

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 245.

List folders. List all the folders in the repository. For more information about listing folders, including
proper syntax, see Listing Folders on page 247.

List objects. List reusable and non-reusable objects in the repository or in a folder. For more information
about listing objects, see Listing Objects on page 247.

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.

ListObjects

243

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.
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.
The following table describes pmrep ListObjects options and arguments:

244

Option

Argument

Description

-o

object_type

Required. Type of object to list.

- When you enter folder, you do not need to include any other option.
pmrep ignores the -t and -f options.
- When you enter objects other than folders, you must include the -f
option.
- When you enter transformation or task, you must include the -f
option, and you can optionally include the -t option.
For a list of object types to use with ListObjects, see Table 6-5 on
page 245.

-t

object_subtype

Optional. Type of transformation or task to list. When you enter

transformation or task for the object type, you can include this option
to return a specific type.
For a list of subtypes to use with ListObjects, see Table 6-6 on
page 246.

-f

folder_name

Required if you list objects other than folders. Folder to search. Use
this option for all object types except deploymentgroup, folder, label,
and query.

-c

column_separator

Optional. Character or set of characters used to separate object

metadata columns. Use a character or set of characters that is not
used in repository object names. If any repository object name
contains spaces, you might want to avoid using a space as a column
separator.
If you omit this option, pmrep uses a single space.

-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.

Chapter 6: pmrep Command Reference

Option

Argument

Description

-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.

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 for object
types.
Table 6-5 describes the object types and rules you use with ListObjects:
Table 6-5. Object Types and Rules
Object Type

Rule

Deploymentgroup

List deployment groups in the repository.

Folder

List folders in the repository.

Label

List labels in the repository.

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.

Query

List queries in the repository.

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.

User Defined Function

List user-defined functions in the repository.

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

245

Table 6-6 describes the object types and values to use with pmrep commands:
Table 6-6. Transformation and Task Types to Use with pmrep

246

Object Type

Subtype Value

Description

Task

assignment

Assignment

Task

command

Command

Task

control

Control

Task

decision

Decision

Task

event_raise

Event-raise

Task

event_wait

Event-wait

Task

start

Start

Task

timer

Timer

Transformation

aggregator

Aggregator

Transformation

application_source_qualifier

Application Source Qualifier

Transformation

app_multi-group_source_qualifier

Application Multi-Group Source Qualifier

Transformation

custom_transformation

Custom

Transformation

custom_transformation

HTTP

Transformation

custom_transformation

SQL

Transformation

custom_transformation

Union

Transformation

custom_transformation

XML Generator

Transformation

custom_transformation

XML Parser

Transformation

expression

Expression

Transformation

external_procedure

External Procedure

Transformation

filter

Filter

Transformation

input_transformation

Input

Transformation

java

Java

Transformation

joiner

Joiner

Transformation

lookup_procedure

Lookup

Transformation

mq_source_qualifier

MQ Source Qualifier

Transformation

normalizer

Normalizer

Transformation

output_transformation

Output

Transformation

rank

Rank

Transformation

router

Router

Transformation

sequence

Sequence Generator

Transformation

sorter

Sorter

Transformation

source_qualifier

Source Qualifier

Transformation

stored_procedure

Stored Procedure

Transformation

transaction_control

Transaction Control

Transformation

update_strategy

Update Strategy

Transformation

xml_source_qualifier

XML Source Qualifier

Chapter 6: pmrep Command Reference

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-6 on page 246.
For example, to list all transformation types in a folder, enter the following text at the prompt:
listobjects -o transformation -f myfolder

pmrep returns the following information:

stored_procedure reusable sp_sproc1
expression reusable exp1
stored_procedure non-reusable mapping1.sp_nsproc
sequence non-reusable smallmapplet.seqgen_empid
.listobjects completed successfully.

To list all Stored Procedure transformations in a folder, enter the following text at the prompt:
listobjects -o transformation -t stored_procedure -f myfolder

pmrep returns the following information:

stored_procedure reusable sp_sproc1
stored_procedure non-reusable mapping1.sp_nsproc
.listobjects completed successfully.

To list all sessions in a folder, enter the following text at the prompt:
listobjects -o session -f myfolder

pmrep returns the following information:

session reusable s_sales_by_CUSTID
session non-reusable wf_sales.s_sales_Q3
session non-reusable wf_orders.wl_shirt_orders.s_shirt_orders
.listobjects completed successfully.

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.

ListTablesBySess

247

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

The ListTablesBySess command uses the following syntax:

listtablesbysess
-f <folder_name>
-s [<qualifying_path>.]<session_name>
-t <object_type_listed> (source or target)

The following table describes pmrep ListTablesBySess options and arguments:

Option

Argument

Description

-f

folder_name

Required. Name of the folder containing the session.

-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_listed

Required. Enter source to list sources, or enter target to list targets.

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

pmrep returns the following information:

ITEMS
mapplet1.ORDERS
Shortcut_To_ITEM_ID
listtablesbysess completed successfully.

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

pmrep returns the following information:

target1_inst
ORDERS_BY_CUSTID
Shortcut_To_tgt2_inst
listtablesbysess completed successfully.

ListUserConnections
Lists information for each user connected to the repository.
The ListUserConnections command uses the following syntax:
listuserconnections

248

Chapter 6: pmrep Command Reference

MassUpdate
Updates session properties for a set of sessions that meet specified conditions. You can update all sessions in a
folder or a list of sessions. To update a list of sessions, create a persistent input file. The list can contain a
specific list of sessions, or it can contain conditions such as a name pattern or a property value. Use
ExecuteQuery to generate a persistent input file.
When you run MassUpdate, you can view information such as the folder name, the number of sessions that are
successfully updated or failed, and the names of the sessions that are updated. You can view the status of the
update in the command line window or in a log file that the command generates. You specify the name and
path for the log file when you run the command. By default, the log file is stored in the directory where you run
the command.
Use MassUpdate to update a session property across multiple sessions when a PowerCenter version changes a
default value.
Note: You cannot update dependent session properties.

Before you update the sessions, you can also run MassUpdate in a test mode to view changes. To view a sample
log file, see Sample Log File on page 253.
The MassUpdate command uses the following syntax:
pmrep massupdate
-t <session_property_type (session_property, session_config_property,
transformation_instance_attribute, session_instance_runtime_option)>
-n <session_property_name>
-v <session_property_value>
[-w <transformation_type>]
{-i <persistent_input_file> | -f <folder_name> }
[-o <condition_operator (equal, unequal, less, greater)>]
[-l <condition_value>]
[-g <update_session_instance_flag>]
[-m <test_mode>]
[-u <output_log_file_name>]

The following table describes pmrep MassUpdate options and arguments:

Option

Argument

Description

-t

session_property_type

Required. Session property type to update. Session properties are

of the following types:
- session_property
- session_config_property
- transformation_instance_attribute
- session_instance_runtime_option
For more information, see Session Property Types on page 250.

-n

session_property_name

Required. Name of the attribute or property to update. For more

information, see Table 6-7 on page 251.

-v

session_property_value

Required. Value that you want to assign to the property.

-w

transformation_type

Required if you update a transformation instance attribute.

Transformation type to update. You can update the following
transformation types: aggregator, joiner, lookup procedure, rank,
sorter, source definition, and target definition.

-i

persistent_input_file

Required if you do not use the -f option. Name of the file that
contains the selected list of sessions to update. You can use the
pmrep ExecuteQuery command to run a query and generate this
file. MassUpdate returns an error if you specify an object that is
not a session. You must use the -i option or the -f option, but not
both.

-f

folder_name

Required if you do not use the -i option. Name of the folder. Use to
update all sessions in a folder. You must use the -i option or the -f
option, but not both.

MassUpdate

249

Option

Argument

Description

-o

condition_operator

Required if you use condition_value. Part of the condition that

defines the session set.
The attribute of a session or session instance is updated when the
condition is met.
You can use the following condition operators to update a string:
equal or unequal.
You can use the following condition operators to update an
integer: equal, unequal, less, or greater.

-l

condition_value

Required if you use a condition operator. Part of the condition. The

condition appears as follows:
<session_property_value> <condition operator>
<condition_value>

-g

update_session_instance
_flag

Required if you update a session instance run-time option.

Optional for the following session property types: session
property, session configuration attribute, and transformation
instance attribute.
Updates session instances.
You can update an attribute in a session instance if the session
instance overrides the attribute.

-m

test_mode

Optional. Runs MassUpdate in test mode. View sessions that will

be impacted by the command before you commit changes. You
can see the following details in the command line window:
- Session name
- Type of session: reusable or non-reusable
- Current value of the session property
- Sessions for which the attribute has the same value and are not
affected by the command.

-u

output_log_file_name

Optional. Name of the log file that stores the status of the update
and basic information about the sessions or session instances.
Previous attribute values are also written to this file. If you do not
use this option, the details appear in the command line window.

The MassUpdate command returns massupdate successfully completed or returns failed to execute
massupdate message. The update might fail for the following reasons:

You did not specify a valid attribute value pertaining to the attribute name.

You specified the correct session property name and the wrong session property type along with it.

You did not specify the -w option while updating a transformation instance attribute.

You did not specify the -g option while updating a session instance run-time option.

You do not have the Repository Services Administrator role.

Session Property Types

When you run MassUpdate, specify the session property type and the name. You specify the following session
property types:

Session properties

Session configuration attributes

Transformation instance attributes

Session instance run time options

session_property

Is Enabled

session_config_property

Java Classpath

session_property

Joiner Data Cache Size

transformation_instance_attribute
The transformation_type argument must be joiner.

Joiner Index Cache Size

transformation_instance_attribute
The transformation_type argument must be joiner.

Line Sequential buffer length

session_config_property

Lookup cache directory name

transformation_instance_attribute
The transformation_type argument must be lookup
procedure.

Lookup Data Cache Size

transformation_instance_attribute
The transformation_type argument must be lookup
procedure.

MassUpdate

251

Table 6-7. Session Properties Used with MassUpdate

252

Session Property

Session Property Type

Lookup Index Cache Size

transformation_instance_attribute
The transformation_type argument must be lookup
procedure.

Maximum Memory Allowed For Auto Memory

Attributes

session_config_property

Maximum Percentage of Total Memory

Allowed For Auto Memory Attributes

session_config_property

On Pre-Post SQL error

session_config_property

On Pre-session command task error

session_config_property

On Stored Procedure error

session_config_property

Output file directory

transformation_instance_attribute
The transformation_type argument must be target definition.

Override tracing

session_instance_runtime_option

Write Backward Compatible Session Log File

session_property

Chapter 6: pmrep Command Reference

Rules and Guidelines

Use the following rules and guidelines when you run MassUpdate:

If the node running the Repository Service process has limited memory, disable repository agent caching
before you run MassUpdate or restart the Repository Service after you run MassUpdate.

You can update reusable and non-reusable sessions.

You cannot revert property values after you run MassUpdate.

You cannot update sessions that are checked out.

You cannot update sessions in frozen folders.

Sample Log File

The following text shows a sample log file generated by pmrep MassUpdate:
cases_auto,s_test_ff,reusable,0
s_test_ff was successfully checked out.
-----------------------------------------------------------------------------11/10/2008 11:12:55 ** Saving... Repository test_ver_MU, Folder cases_auto
-----------------------------------------------------------------------------Session s_test_ff updated.
Checking-in saved objects...done
-----------------------------------------------------------------------------cases_auto,wf_non_reusable_test_ff.s_test_ff_non_reusable,non-reusable,0
wf_non_reusable_test_ff was successfully checked out.
-----------------------------------------------------------------------------11/10/2008 11:12:57 ** Saving... Repository test_ver_MU, Folder cases_auto
-----------------------------------------------------------------------------Validating the flow semantics of Workflow wf_non_reusable_test_ff...
...flow semantics validation completed with no errors.
Validating tasks of Workflow wf_non_reusable_test_ff...
...Workflow wf_non_reusable_test_ff tasks validation completed with no errors.
Workflow wf_non_reusable_test_ff updated.
Checking-in saved objects...done
-----------------------------------------------------------------------------Massupdate Summary:
Number of reusable sessions that are successfully updated: 1.
Number of non-reusable sessions that are successfully updated: 1.
Number of session instances that are successfully updated: 0.
Number of reusable sessions that fail to be updated: 0.
Number of non-reusable sessions that fail to be updated: 0.
Number of session instances that fail to be updated: 0.
------------------------------------------------------------------------------

RELATED TOPICS:
ExecuteQuery on page 238

ModifyFolder
Modifies folder properties. You modify a folder in a non-versioned repository.
The command returns ModifyFolder successfully completed or returns ModifyFolder Failed message. The
modification might fail for the following reasons:

ModifyFolder

253

The folder does not exist.

The new owner does not exist or does not belong to the group.

A folder with the new folder name already exists.

The ModifyFolder command uses the following syntax:

modifyFolder
-n <folder_name>
[-d <folder_description>]
[-o <owner_name>]
[-a <owner_security_domain>]
[-s (shared folder)]
[-p <permissions>]
[-r <new_folder_name>]
[-f <folder_status> (active, frozendeploy, or frozennodeploy)]
[-u <os_profile>]

The following table describes the pmrep ModifyFolder options and arguments:
Option

Argument

Description

-n

folder_name

Required. New folder name.

-d

folder_description

Optional. Description of the folder that displays in the Repository

Manager.

-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.

-a

owner_security_domain

Required if you use LDAP authentication. Name of the security

domain that the owner belongs to. Default is Native.

-s

shared_folder

Optional. Makes the folder shared.

-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 232.

-r

new_folder_name

Optional. New name of the folder.

-f

folder_status

Optional. Change the folder status to one of the following status:

-u

os_profile

Optional. Assigns an operating system profile to the folder.

Notify
Sends notification messages to users connected to a repository or users connected to all repositories managed by
a Repository Service.
The Notify command uses the following syntax:
notify
-m <message>

254

Chapter 6: pmrep Command Reference

The following table describes pmrep Notify option and argument:

Option

Argument

Description

-m

message

Required. Message you want to send.

The command returns notify successfully completed or returns failed to execute notify message. The
notification might fail for the following reasons:

The message you entered is invalid.

You failed to connect to the Repository Service.

The Repository Service failed to notify users.

ObjectExport
Exports objects to an XML file defined by the powrmart.dtd file. 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.
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.
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>]

The following table describes pmrep ObjectExport options and arguments:

Option

Argument

Description

-n

object_name

Required if you do not use the -i option. 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. Use the -n option or the -i option, but
not both.

-o

object_type

Object type of the object name. You can specify source, target,
transformation, mapping, mapplet, session, worklet, workflow,
scheduler, session config, or task. If you use this option, you cannot
use the -i option.

-t

object_subtype

Type of transformation or task. This argument is ignored for other

object types. For valid subtypes, see Table 6-6 on page 246.

ObjectExport

255

Option

Argument

Description

-v

version_number

Optional. Exports the version of the object that you enter.

-f

folder_name

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

-n map -o mapping -f folder1 -u map.xml

The following example exports the objects identified in a persistent input file named persistent_input.xml to a
file named map.xml:
objectexport

-i persistent_input.txt -u map.xml

Note: If you use a manually created persistent input file, since you enter none for the encoded ID, the
following message appears: Ids are invalid. Trying with names for [none,folder1,map,mapping,none,1].

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.
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)]

The following table describes pmrep ObjectImport options and arguments:

256

Option

Argument

Description

-i

input_XML_file_name

Required. Name of the XML file to import.

-c

control_file_name

Required. Name of the control file that defines import options.

Chapter 6: pmrep Command Reference

Option

Argument

Description

-l

log_file_name

Optional. Log file that records each export step. If you omit this option,
status messages output to the window.

-p

n/a

Optional. Retains persistent values for mapping variables.

Note: The ObjectImport command does not create a folder if the folder name you enter does not exist in the
repository.

PurgeVersion
Purges object versions from the repository database. You can purge versions of deleted objects and active
objects. An object is a deleted object if the latest version is checked in and it has the version status Deleted.
Other objects are active objects.
When you purge versions of deleted objects, you purge all versions. The deleted objects must be checked in.
You can purge versions for all deleted objects or for objects deleted before a specified end time. You can specify
the end time as a date and time, a date only, or a number of days before the current date.
When you purge versions of active objects, you can specify purge criteria. You can specify the number of
versions to keep and purge the previous versions, and you can purge versions that are older than a specified
purge cutoff time. You cannot purge a checked-out version or the latest checked-in version.
If you purge versions of a composite object, you need to consider which versions of the dependent objects are
purged.
The PurgeVersion command uses the following syntax:
purgeversion
{-d <all | time_date | num_day> |
{-n <last_n_versions_to_keep> |
-t <time_date | num_day>}}
[-f <folder_name>]
[-q <query_name>]
[-o <output_file_name>]
[-p (preview purged objects only)]
[-b (verbose)]
[-c (check deployment group reference)]

The following table describes pmrep PurgeVersion options and arguments:

Option

Argument

Description

-d

all
time_date
num_day

Required if you do not use -n or -t. Purges all versions of

checked-in deleted objects. You can specify all for all deleted
objects, or you can specify an end time to purge all versions of
objects that were deleted before the end time. You specify the end
time in MM/DD/YYYY HH24:MI:SS format, MM/DD/YYYY format,
or as the number of days before the current date. If you specify a
number of days, the value must be an integer greater than 0.

-n

last_n_versions_to_keep

Required if you do not use -d or -t. Number of latest checked-in

object versions to keep for an active object. The value must be an
integer greater than 0. For example, enter 6 to purge all versions
except the last six checked-in versions. If the object is checked out,
you also retain the checked-out version.
Note: After you purge object versions, you cannot retrieve them. To
ensure that you can revert to past versions, avoid purging all
versions of an object.

PurgeVersion

257

Option

Argument

Description

-t

purge_cutoff_time

Required if you do not use -d or -n. Cutoff time for purging object
versions of active objects. Purges versions that were checked in
before the cutoff time. You can specify the purge cutoff time in
MM/DD/YYYY HH24:MI:SS format, MM/DD/YYYY format, or as a
number of days before the current date. If you specify a number of
days, the value must be an integer greater than 0. When you use
the -t option, you retain the latest checked-in version even if it was
checked in after the purge cutoff time.

-f

folder_name

Optional. Folder from which object versions are purged. If you do

not specify a folder, you purge object versions from all folders in
the repository.

-q

query_name

Optional. Query used to purge object versions from a particular

query result set.
Note: If you use the -d option, you purge all versions of the deleted
objects. To keep recent versions of deleted objects and purge older
versions, you can define a query that returns the deleted objects
and then use the -q option with -n, -t, or both.

-o

outputfile_name

Optional. Output file for saving information about purged object

versions.

-p

n/a

Optional. Previews the PurgeVersion command. pmrep displays

the purge results without actually purging object versions.

-b

n/a

Optional. Displays or saves purge information in verbose mode.

Verbose mode provides detailed information about object versions,
including repository name, folder name, version number, and
status. You can use the -b option with -o and -p.

-c

n/a

Optional. Checks deployment groups in the repository for

references to the object versions returned in a purge preview. If a
purge preview contains an object version in a deployment group,
pmrep displays a warning. If you use the -c option, you must also
use the -p option.
Note: The -c option can have a negative impact on performance.

Examples
The following example purges all versions of all deleted objects in the repository:
pmrep purgeversion -d all

Note: For optimal performance, purge at the folder level or use purge criteria to reduce the number of purged
object versions. Avoid purging all deleted objects or all older versions at the repository level.

The following example purges all but the latest checked-in version of objects in the folder1 folder:
pmrep purgeversion -n 1 -f folder1

The following example previews a purge of all object versions that were checked in before noon on January 5,
2005, and outputs the results to the file named purge_output.txt:
pmrep purgeversion -t '01/05/2005 12:00:00' -o purge_output.txt -p

Register
Registers a local repository with a connected global repository. You must connect to the global repository before
you register the local repository.

258

Chapter 6: pmrep Command Reference

Also, you must run the Repository Service for the local repository in exclusive mode. You can configure the
Repository Service to run in exclusive mode in the Administration Console or you can use the infacmd
UpdateRepositoryService command.
The command returns register successfully completed or returns failed to execute register message. The
registration might fail for the following reasons:

You failed to connect to the Repository Service.

The local repository is not running in exclusive mode.

The Repository Service failed to initialize information about the global repository.

The Repository Service failed to register the local repository with the global repository.

The Register command uses the following syntax:

register
-r <local_repository_name>
-n <local_repository_user_name>
[-s <local_repository_user_security_domain>]
[-x <local_repository_password> |
-X <local_repository_password_environment_variable>]
[-d <local_repository_domain_name> |
{-h <local_repository_portal_host_name>
-o <local_repository_portal_port_number>}] (if local repository is in a different domain)

The following table describes pmrep Register options and arguments:

Option

Argument

Description

-r

local_repository_name

Required. Name of the local repository to register.

-n

local_repository_user_name

Required. Local user name.

-s

local_repository_user_security_
domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-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.

-X

repository_password_
environment_variable

Optional. Login password environment variable for the local

target repository. You use the -x or -X option, but not both. If
you do not use the -x or -X option, pmrep prompts you for
the password.

-d

local_repository_domain_name

Required if the local repository is in a different domain and

you do not use the -h and -o options. Name of the
PowerCenter domain for the repository.

-h

local_repository_portal_host_
name

Required if the local repository is in a different domain and

you do not use -d. Machine name of the domain where the
local repository is located. If you use this option, you must
also use the -o option.

-o

local_repository_portal_port_
number

Required if the local repository is in a different domain and

you do not use -d. Port number for the domain where the
local repository is located. If you use this option, you must
also use the -h option.

RegisterPlugin
Registers an external plug-in to a repository. Registering a plug-in adds its functionality to the repository. Use
the RegisterPlugin command to update existing plug-ins.

RegisterPlugin

259

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.
The RegisterPlugin command uses the following syntax:
registerplugin
-i <input_registration_file_name_or_path>
[-e (update plug-in)]
[-l <NIS_login>
{-w <NIS_password> |
-W <NIS_password_environment_variable>}
[-k (CRC check on security library)]]
[-N (is native plug-in)]

The following table describes pmrep RegisterPlugin options and arguments:

260

Option

Argument

Description

-i

input_registration_file_name_or_
path

Required. Name or path of the registration file for the

plug-in.

-e

n/a

Optional. Update an existing plug-in. Not applicable for

authentication modules.

-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.

-w

NIS password

Optional. Use to register authentication module

components.
External directory password of the user registering the
module. If the plug-in contains an authentication module,
you must supply the user password from the external
directory or the registration fails. Do not use this option for
other plug-ins.
Use the -w or -W option, but not both. If you do not supply a
password or password environment variable, pmrep
prompts you for a password.

-W

NIS_password_environment_
variable

Optional. Use to register authentication module

components.
External directory password environment variable of the
user registering the module. If the plug-in contains an
authentication module you must supply the user password
from the external directory or the registration fails. Do not
use this option for other plug-ins.
Use the -w or -W option, but not both. If you do not supply a
password or password environment variable, pmrep
prompts you for a password.

-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.

-N

n/a

Registers a plug-in. Required when the following conditions

are true:
- You upgrade PowerCenter.
- The PowerCenter upgrade does not have a new repository
version.
- The plug-in contains updated functionality.
- The plug-in is registered by default with a new
PowerCenter installation.
For information about plug-ins that you need to register
when you upgrade, see the PowerCenter Release Guide.

Chapter 6: pmrep Command Reference

Registering a Security Module

If you want to use an external directory service to maintain users and passwords for a repository, you must
register the security module with the repository. Use the Registerplugin command to register the security
plug-in.

Example
You administer PowerCenter for an organization that has a centralized LDAP NIS for user authentication.
When you upgrade PowerCenter, you decide to use the LDAP for user authentication. The upgrade installs the
LDAP security module in the repository security folder. After connecting to the repository with the Connect
command, the administrator runs the pmrep command to register the new external module with the repository:
pmrep registerplugin -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.

Restore
Restores a repository backup file to a database. The target database must be empty.
The pmrep Restore command uses the following syntax:
restore
-u <domain_user_name>
[-s <domain_user_security_domain>]
[-p <domain_password> |
-P <domain_password_environment_variable>]
-i <input_file_name>
[-g (create global repository)]
[-y (enable object versioning)]
[-b (skip workflow and session logs)]
[-j (skip deployment group history)]
[-q (skip MX data)]
[-f (skip task statistics)]
[-a (as new repository)]
[-e (exit if domain name in the binary file is different from current domain name)]

The following table describes pmrep Restore options and arguments:

Option

Argument

Description

-u

domain_user_name

Required. User name.

-s

domain_user_security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-p

domain_password

Optional. Password. You can use the -p or -P option, but not

both. If you do not use the -p or -P option, pmrep prompts
you for the password.

-P

domain_password_
environment_variable

Optional. Password environment variable. You can use the -p

or -P option, but not both. If you do not use the -p or -P
option, pmrep prompts you for the password.

-i

input_file_name

Required. Name of the repository backup file. Use a file

name and path local to the Repository Service.

Restore

261

Option

Argument

Description

-g

n/a

Optional. Promotes the repository to a global repository.

-y

n/a

Optional. Enables object versioning for the repository.

-b

n/a

Optional. Skips tables related to workflow and session logs

during restore.

-j

n/a

Optional. Skips deployment group history during restore.

-q

n/a

Optional. Skips tables related to MX data during restore.

-f

n/a

Optional. Skips task statistics during restore.

-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.

-e

n/a

Optional. Exits if domain name in the binary file is different

from current domain name

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

RollbackDeployment
Rolls back a deployment to purge a deployed version from the target repository or folder and revert objects to a
previous version of deployment. Use this command to roll back all the objects in a deployment group that you
deployed at a specific date and time. You cannot roll back part of the deployment. To roll back, you must
connect to the target repository. You cannot roll back a deployment from a non-versioned repository.
To initiate a rollback, you must roll back the latest version of each object.
The RollbackDeployment command uses the following syntax:
rollbackdeployment -p <deployment_group_name> -t <nth_latest_deploy_run>

The following table describes the pmrep RollbackDeployment options and arguments:
Option

Argument

Description

-p

deployment_group_name

Required. Name of the deployment group to roll back.

-t

nth_latest_deploy_run

Required. Version of the deployment you want to roll back.

Example
You have a deployment with five versions and want to rollback the last two versions. To do this, you must first
roll back the latest deployment. Enter the following text at the prompt to roll back once and purge the last
deployment:
rollbackdeployment -p Deploy_sales -t 1

Next, enter the following text to roll back the next to last deployment:
rollbackdeployment -p Deploy_sales -t 2

262

Chapter 6: pmrep Command Reference

Run
Opens a script file containing multiple pmrep commands, reads each command, and runs them. If the script file
is UTF-8 encoded, you must use the -u option and the repository code page must be UTF-8. If you run a
UTF-8 encoded script file that includes the Connect command against a repository that does not have a UTF-8
code page, the Run command will fail.
If the script file is not UTF-8 encoded, omit the -u option. If you use the -o option and the -u option, pmrep
generates the output file in UTF-8. If you use the -o option and omit the -u option, pmrep generates the output
file based on the system locale of the machine where you run pmrep.
The command returns run successfully completed or returns run failed message. The run might fail if the
Repository Service cannot open the script file or output file.
The Run command uses the following syntax:
run
-f <script_file_name>
[-o <output_file_name>]
[-e (echo commands)]
[-s (stop at first error)]
[-u (UTF-8 encoded script file and output file)]

The following table describes pmrep Run options and arguments:

Option

Argument

Description

-f

script file name

Required. Name of the script file.

-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.

-e

n/a

Optional. Commands are echoed back to the script.

-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.

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, 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.
The ShowConnectionInfo command uses the following syntax:
showconnectioninfo

It returns information similar to the following:

Connected to Repository MyRepository in MyDomain as user MyUserName

Run

263

SwitchConnection
Changes the name of an existing connection. When you use SwitchConnection, the Repository Service replaces
the relational database connections for all sessions using the connection in one of the following locations:

Source connection

Target connection

Connection Information property in Lookup transformations

Connection Information property in Stored Procedure transformations

$Source Connection Value session property

$Target Connection Value session property

If the repository contains both relational and application connections with the same name and you specified the
connection type as relational in all locations in the repository, the Repository Service replaces the relational
connection.
For example, you have a relational and an application source, each called ITEMS. In a session, you specified the
name ITEMS for a relational source connection instead of Relational:ITEMS. When you use
SwitchConnection to replace the relational connection ITEMS with another relational connection, pmrep does
not replace any relational connection in the repository because it cannot determine the connection type for the
source connection entered as ITEMS.
The SwitchConnection command uses the following syntax:
switchconnection
-o <old_connection_name>
-n <new_connection_name>

The following table describes pmrep SwitchConnection options and arguments:

Option

Argument

Description

-o

old_connection_name

Required. Name of the connection you want to change.

-n

new_connection_name

Required. New connection name.

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.
The command returns truncatelog completed successfully or returns Failed to execute truncatelog message.
The truncate operation might fail for the following reasons:

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 up to end time in MM/DD/YYYY HH24:MI:SS format or as number of
days before current date)>
[-f <folder_name>]
[-w <workflow_name>]

264

Chapter 6: pmrep Command Reference

The following table describes pmrep TruncateLog options and arguments:

Option

Argument

Description

-t

logs_truncated

Required. Use all to delete all logs, or enter an end time. pmrep
deletes all logs older than the end time. You can enter the end time
with the format MM/DD/YYYY HH24:MI:SS, or you can specify the
number of days before the current date. If you specify the number of
days, the end time must be an integer greater than 0.

-f

folder_name

Optional. Deletes logs associated with the folder. If you do not give
both the folder name and the workflow name, then pmrep deletes all
logs from the repository.

-w

workflow_name

Optional. Deletes logs associated with the workflow. The Repository

Service deletes all logs from the repository if you do not give both the
folder name and the workflow name. If you give both the folder name
and workflow name, the Repository Service deletes logs associated
with the workflow. If you enter the workflow name, you must also
provide the folder name.

UndoCheckout
Reverses the checkout of an object. When you undo a checkout, the repository releases the write-intent lock on
the object and reverts to the most recently checked in version of the object. If you want to modify the object
again, you must check it out.
The UndoCheckout command uses the following syntax:
undocheckout
-o <object_type>
[-t <object_subtype>]
-n <object_name>
-f <folder_name>

The following table describes pmrep UndoCheckout options and arguments:

Option

Argument

Description

-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-6 on page 246.

-n

object_name

Required. Name of the checked out object.

-f

folder_name

Required. Name of the folder containing the object.

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.
The command returns unregister successfully completed or returns failed to execute unregister message. The
registration might fail for the following reasons:
UndoCheckout

265

The Repository Service for the local repository is not running in exclusive mode.

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>
[-s <local_repository_user_security_domain>]
[-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>}] (if local repository is in a different domain)

The following table describes pmrep Unregister options and arguments:

Option

Argument

Description

-r

local_repository_name

Required. Name of the local repository to unregister.

-n

local_repository_user_name

Required. Local user name.

-s

local_repository_user_
security_domain

Required if you use LDAP authentication. Name of the

security domain that the user belongs to. Default is Native.

-x

local_repository_password

Required if you do not use the -X option. Login password for

the local target repository. You must use the -x or -X option,
but not both.

-X

local_repository_password_
environment_variable

Required if you do not use the -x option. Login password

environment variable for the local target repository. You must
use the -x or -X option, but not both.

-d

local_repository_domain_
name

Required if the local repository is in a different domain and you

do not use the -h and -o options. Name of the PowerCenter
domain for repository.

-h

local_repository_portal_host_
name

Required if the local repository is in a different domain and you

do not use the -d option. Machine name of the domain where
the local repository is located. If you use this option, you must
also use the -o option.

-o

local_repository_portal_port_
number

Required if the local repository is in a different domain and you

do not use the -d option. Port number for the domain where
the local repository is located. If you use this option, you must
also use the -h option.

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.
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.
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)]

266

Chapter 6: pmrep Command Reference

{-w <new_password> |
-W <new_password_environment_variable>}]

The following table describes pmrep UnregisterPlugin options and arguments:

Option

Argument

Description

-v

vendor_id

Required. Identifies the security plug-in by vendor

identification number. You define this number when you
register the plug-in.

-l

plug-in_id

Required. Identifies the plug-in by identification number. You

define this identification number when you register the plug-in.

-s

n/a

Optional. Indicates whether the module is an external security

module.

-g

n/a

Optional. Applicable when registering an external security

module.
Removes the association between user names and login
names in the repository when you unregister an external
security module. If you omit this option, you retain the
association in the repository, but the Repository Manager
does not display it anywhere.
Use this option when you are unregistering a security module.

-w

new_password

Required when the plug-in contains a security module.

Required if you do not use the -W option. You must use the -w
or -W option, but not both.
Specifies a new password 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.

-W

new_password_environment_
variable

Required when the plug-in contains a security module.

Required if you do not use the -w option. You must use the -w
or -W option, but not both.
Specifies a new password environment variable for the user
running the unregister command. When you UnregisterPlugin
an external authentication module, all user passwords reset to
the values in the repository. You must enter a new password
to access the repository.

Unregistering an External Security Module

Use the UnregisterPlugin command to discontinue using an external security module with a repository. If you
unregister the external security module, PowerCenter switches to repository authentication mode. All user
passwords reset to the values in the repository instead of the values in the external directory. When you
unregister the security module, you do not lose the mapping between the user names and the external security
login names unless you enter the -g option. Use the mapping again if you register a new security module.
Note: Although you can save the associations between external logins and user names, the Repository Manager
does not display the external logins while running under user authentication.

You must use the -w or -W option to create a new password when you unregister the security module.

Example
As an administrator, you decide to switch from the LDAP security module back to repository authentication.
You remove the user name-login mapping. Any users that you added to the system under repository
authentication can log in with their old user names and passwords. Any users you added to the repository under
the LDAP security cannot log in until you enable their user names.
Note: You must provide the LDAP NIS login and password to use the UnregisterPlugin command. You must
also provide a new password to use after you switch back to user authentication.

UnregisterPlugin

267

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.

pmrep cannot acquire a lock on the object.

One of the required parameters is missing.

The UpdateConnection command uses the following syntax:

updateconnection
-t <connection_subtype >
-d <connection_name>
[-u <new_user_name>]
[-p <new_password>|-P <new_password_environment_variable>]
[-c <new_connection_string>]
[-a <attribute_name>
-v <new_attribute_value>]
[ -s <connection type application, relational, ftp, loader or queue > ]
[-l <code page>]

The following table describes pmrep UpdateConnection options and arguments:

Option

Argument

Description

-t

connection_subtype

Required. Type of relational connection. For valid database types, see

Table 6-4 on page 229.

-d

connection_name

Required. Database connection name.

-u

new_user_name

Optional. User name used for authentication when you connect to the
relational database.

-p

new_password

Optional. Password used for authentication when you connect to the

relational database. Use the -p or -P option, but not both.

-P

new_password_
environment_variable

Optional. Password environment variable used for authentication when

you connect to the relational database. Use the -p or -P option, but not
both.

-c

new_connection_string

Optional. Connect string the Integration Service uses to connect to the

relational database. For native connect strings, see Table 6-3 on
page 226.

-a

attribute_name

Optional. Name of the attribute.

-v

new_attribute_value

Required if you use the -a option. New attribute value of the

connection. Enter yes to enable new attributes, and no to disable
new attributes.

-s

connection type
application, relational,
ftp, loader or queue

Optional. Type of connection. A connection can be one of the following

types:
- Application
- FTP
- Loader
- Queue
- Relational

-l

code page

Optional. Code page associated with the connection.

RELATED TOPICS:
Specifying the Database Code Page on page 231

268

Chapter 6: pmrep Command Reference

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.
The UpdateEmailAddr command uses the following syntax:
updateemailaddr
-d <folder_name>
-s <session_name>
-u <success_email_address>
-f <failure_email_address>

The following table describes pmrep UpdateEmailAddr options and arguments:

Option

Argument

Description

-d

folder_name

Required. Name of the session folder.

-s

session_name

Required. Name of the session.

-u

success_email_address

Required. Email address to send session success notifications.

-f

failure_email_address

Required. Email address to send session failure notifications.

UpdateSeqGenVals
Updates one or more of the following properties for the specified Sequence Generator transformation:

Start Value

End Value

Increment By

Current Value

You might want to update sequence values when you move a mapping from a development environment to a
production environment. Use the UpdateSeqGenVals command to update reusable and non-reusable Sequence
Generator transformations. However, you cannot update values for instances of reusable Sequence Generator
transformations or shortcuts to Sequence Generator transformations.
The UpdateSeqGenVals command uses the following syntax:
updateseqgenvals
-f <folder_name>
[-m <mapping_name>]
-t <sequence_generator_name>
[-s <start_value>]
[-e <end_value>]
[-i <increment_by>]
[-c <current_value>]

UpdateEmailAddr

269

The following table describes pmrep UpdateSeqGenVals options and arguments:

Option

Argument

Description

-f

folder_name

Required. Folder name.

-m

mapping_name

Mapping name. When you update values for a non-reusable

Sequence Generator transformation, you must include the
mapping name.

-t

sequence_generator_name

Required. Sequence Generator transformation name.

-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.

-e

end_value

Optional. Maximum value the Integration Service generates. If

the Integration Service reaches this value during the session and
the sequence is not configured to cycle, it fails the session.
If you designate an invalid value, pmrep displays an error
message and does not update the Sequence Generator
transformation.

-i

increment_by

Optional. Difference between two consecutive values from the

NEXTVAL port.
If you designate an invalid value, pmrep displays an error
message and does not update the Sequence Generator
transformation.

-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.

UpdateSrcPrefix
Updates the owner name for session source tables. You can update the owner name for one or all sources in a
session. Updatesrcprefix updates the owner name for source tables at the session level.
pmrep updates source table owner names if you previously edited the source table name in the session
properties.
The UpdateSrcPrefix command uses the following syntax:
updatesrcprefix
-f <folder_name>
-s [<qualifying_path>.]<session_name>
[-t <source_name>]
-p <prefix_name>
[-n (use source instance name; not using -n gives old, deprecated behavior)]

270

Chapter 6: pmrep Command Reference

The following table describes the pmrep UpdateSrcPrefix options and arguments:
Option

Argument

Description

-f

folder_name

Required. Name of the folder containing the session.

-s

session_name

Required. Name of the session containing the sources to update.

For reusable sessions, enter the session name.
For non-reusable sessions, you must also enter the session
path, such as worklet_name.session_name or
workflow_name.session_name.

-t

source_name

Optional. Name of the source to update.

If you omit this option, pmrep updates all source table owner
names in the session.
When you include the -n option, you enter the name of the
source instance as displayed in the session properties or as
output by the ListTablesBySess command.
Although the UpdateSrcPrefix command will run without the -n
option, include the -n option to use the source instance name.
If you omit the -n option, you must enter the dbd name and the
source table name as dbd_name.source_name. You can find the
source dbd name in the Designer Navigator. The Designer
generates the dbd name from the source type or data source
name when you create a source definition in the repository.

-p

prefix_name

Required. Owner name you want to update in the source table.

-n

n/a

Optional. Matches the source_name argument with source

instance names.
Although the UpdateSrcPrefix command will run without the -n
option, include the -n option to use the source instance name.
When you do not include this option, pmrep matches the
source_name argument with the source table names.

UpdateStatistics
Updates statistics for repository tables and indexes.
The command returns updatestatistics completed successfully or returns updatestatistics failed message.
The UpdateStatistics command uses the following syntax:
updatestatistics

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.
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)]

UpdateStatistics

271

The following table describes the pmrep UpdateTargPrefix options and arguments:
Option

Argument

Description

-f

folder_name

Required. Name of the folder containing the session.

-s

session_name

Required. Name of the session containing the targets to update.

For reusable sessions, enter the session name.
For non-reusable sessions, enter the session name and session
path, such as worklet_name.session_name or
workflow_name.session_name.

-t

target_name

Optional. Name of the target to update.

If you omit this option, pmrep updates all target table name
prefixes in the session.
When you include the -n option, you can enter the name of the
target instance as displayed in the session properties or as
output by the ListTablesBySess command.
Although the UpdateTargPrefix command will run without the -n
option, include the -n option to use the target instance name.
When you omit the -n option, you must enter the target table
name instead of the target instance name.

-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.

Upgrade
Upgrades a repository to the latest version.
The Upgrade command uses the following syntax:
upgrade
[-x <repository_password_for_confirmation> |
-X <repository_password_environment_variable_for_confirmation>]

The following table describes pmrep Upgrade options and arguments:

Option

Argument

Description

-x

repository_ password_for_
confirmation

Optional. Password. You can use the -x or -X option, but not

both. If you do not use the -x or -X option, pmrep prompts you to
enter the password for confirmation.

-X

repository_password_
environment_variable_for_
confirmation

Required if you do not use the -x option. Password environment

variable. You must use the -x or -X option, but not both.

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

272

Chapter 6: pmrep Command Reference

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.

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>]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]

The following table describes pmrep Validate options and arguments:

Option

Argument

Description

-n

object_name

Required. Name of the object to validate. Do not use this option

if you use the -i argument.

-o

object_type

Required if you are not using a persistent input file. Type of

object to validate. You can specify source, target,
transformation, mapping, session, worklet, workflow, scheduler,
session config, task, cube, dimension.

-v

version_number

Optional. Version of the object to validate. Default is the latest or

checked out version of the object.

-f

folder_name

Required. Name of the folder containing the object.

-i

persistent_input_file

Optional. Text file from ExecuteQuery, Validate, or

ListObjectDependencies commands. Contains a list of object
records. You cannot use this file if you specify objects using the
-n, -o, or -f arguments.

Validate

273

Option

Argument

Description

-s

n/a

Optional. Save objects that change from invalid to valid to the

repository.

-k

n/a

Required if you use -s. Check in saved objects.

-m

check_in_comments

Required if you use the -k option, and the current repository

requires checkin comments. Add comments when you check in
an object.

-p

output_option_types

Required if you use the -u argument. Type of object you want to

output to the persistent output file or stdout after validation. You
can specify valid, saved, skipped, save_failed, invalid_before, or
invalid_after. To enter one or more options, separate them by
commas.

-u

persistent_output_file_name

Required if you use the - p argument. Name of an output text file.

If you enter a file name, the query writes the results to a file.

-a

append

Optional. Append the results to the persistent output file instead

of overwriting it.

-c

column_separator

Optional. Character or set of characters used to separate object

metadata columns.
Use a character or set of characters that is not used in repository
object names. If any repository object name contains spaces,
you might want to avoid using a space as a column separator.
If you omit this option, pmrep uses a single space.

-r

end-of-record_separator

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. 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.

Version
Displays the PowerCenter version and Informatica trademark and copyright information.
The Version command uses the following syntax:
version

274

Chapter 6: pmrep Command Reference

CHAPTER 7

Working with pmrep Files

This chapter includes the following topics:

Working with pmrep Files Overview, 275

Using the Persistent Input File, 275

Using the Object Import Control File, 277

Object Import Control File Examples, 280

Using the Deployment Control File, 286

Deployment Control File Examples, 290

Tips, 291

Working with pmrep Files 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 275.

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 277.

Deployment control file. You can copy the objects in a dynamic or static deployment group to multiple
target folders in the target repository. For more information about deployment control files, see Using the
Deployment Control File on page 286.

Using the Persistent Input File

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

AddToDeploymentGroup. Add objects to a deployment group.

275

ApplyLabel. Label objects.

ExecuteQuery. Run a query to create a persistent input file. Use the file for other pmrep commands.

ListObjectDependencies. List dependency objects. This command can use a persistent input file for
processing, and it can create one.

MassUpdate. Updates session properties for a set of sessions.

ObjectExport. Export objects to an XML file.

Validate. Validate objects. This command can use a persistent input file for processing, and it can create one.

The persistent input file uses the following format:

encoded ID, foldername, object_name, object_type, object_subtype, version_number,
reusable|non-reusable

Creating a Persistent Input File with pmrep

You can create a persistent input file using the pmrep ExecuteQuery, Validate, or ListObjectDependencies
commands. These commands create files that contain a list of objects with encoded IDs and a cyclic redundancy
check (CRC) value. It also contains an encrypted repository GID. This ID identifies which repository the
record comes from.
The pmrep commands that use a persistent input file get object information from the encoded IDs. The
encoded IDs enable pmrep to process the input file quickly.
When you create a persistent input file with pmrep, it creates the file in the pmrep installation directory. You can
specify a different path.
The following text shows a sample persistent input file:
2072670638:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944199885:138608640183285:1376256153425:131072168215:65536142655:0288235:088154:6553612285
5,EXPORT,M_ITEMS,mapping,none,2
1995857227:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944135065:13867417666804:1376256233835:19660880104:65536271545:0319425:017154:6553644164,E
XPORT,M_ITEMS_2,mapping,none,3
1828891977:57bfc2ff-df64-40fc-9cd4a15cb489bab8:3538944279765:138739712184505:137625613474:65536221345:65536133675:091734:09053:65536156675,EX
PORT,M_NIELSEN,mapping,none,1
3267622055:57bfc2ff-df64-40fc-9cd4a15cb489bab8:353894462954:138805248300075:1376256151365:6553675414:65536174015:0273455:0241435:65536261685,
EXPORT,M_OS1,mapping,none,1

Example
You can use the ExecuteQuery command to create a persistent input file of objects to process in another pmrep
command. For example, you want to export all logically deleted objects from the repository. You might create a
query called find_deleted_objects. When you run the query with pmrep, as shown here, it finds all the deleted
objects in the repository and outputs the results to a persistent input file:
ExecuteQuery -q find_deleted_objects -t private -u deletes_workfile

You can then use deletes_workfile as the persistent input file to ObjectExport:
ObjectExport -i deletes_workfile -u exported_del_file

ObjectExport exports all the referenced objects to an XML file called exported_del_file.

Creating a Persistent Input File Manually

If you want to run pmrep commands against a set of objects that you cannot identify through commands such as
ExecuteQuery, you can manually create an input file.
Use the following rules and guidelines when you create a persistent input file:

276

Enter none for the encoded ID. The pmrep commands get the object information from the other
arguments in the records.

For source objects, enter the object name as <DBD_name>.<source_name>.

Chapter 7: Working with pmrep Files

For objects, such as mappings, that do not have a sub_type, enter none as object_subtype, or leave it blank.
For information about valid transformations and task types, see Table 6-6 on page 246.

For versioned repositories, enter the version number of the object you want, or enter LATEST to use the
latest version of the object.

For non-versioned repositories, leave the version_number argument blank.

For object types, such as targets, that are not reusable or non-reusable, drop the argument.

You cannot include non-reusable objects. You can specify the reusable parent of the non-reusable object.
For example, you want to list the object dependencies for a non-reusable Filter transformation. You can
specify the mapping that is the parent object of the transformation:
none,CAPO,m_seqgen_map,mapping,none,1,reusable

The mapping m_seqgen_map is the reusable parent of the Filter transformation. The command runs
successfully when you specify the reusable parent.
Note: When you use a manually created persistent input file, the Repository Service returns a message indicating
that the ID is not valid. This is an informational message. The Repository Service recognizes that this is a
manually created input file and can process the command with none as the ID.

Example
The following example shows a manually created persistent input file:
none,EXPORT,CustTgt,target,none,2
none,EXPORT,S_Orders,session,,2,reusable
none,EXPORT,EXP_CalcTot,transformation,expression,LATEST,reusable

In the first record, CustTgt is a target definition. Targets have no subtype, so you enter none for the
object_subtype argument. A target cannot be reusable or non-reusable, so you drop the reusable argument.
Note that the record has six arguments instead of seven.
In the second record, S_Orders is a session. Sessions have no subtype, so you leave the argument blank.
In the third record, you want the latest version of the transformation, so you enter LATEST for the
version_number argument.

Using the Object Import Control File

When you use the pmrep ObjectImport command, you can supply a control file to answer questions that you
normally address when you import objects with the Import Wizard. To create a control file, you must create an
XML file defined by impcntl.dtd. The import control file is installed with the PowerCenter Client, and you
must include its location in the input XML file.
The following is a sample of the impcntl.dtd file:







<!ELEMENT IMPORTPARAMS (FOLDERMAP*, TYPEFILTER*, RESOLVECONFLICT?)>
<!ATTLIST IMPORTPARAMS
CHECKIN_AFTER_IMPORT
(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"
>

Using the Object Import Control File

277

<!ELEMENT FOLDERMAP EMPTY>
<!ATTLIST FOLDERMAP
SOURCEFOLDERNAME
CDATA
#REQUIRED
SOURCEREPOSITORYNAME CDATA
#REQUIRED
TARGETFOLDERNAME
CDATA
#REQUIRED
TARGETREPOSITORYNAME CDATA
#REQUIRED
>


<!ELEMENT TYPEFILTER EMPTY>
<!ATTLIST TYPEFILTER
TYPENAME
CDATA
#REQUIRED
>

<!ELEMENT RESOLVECONFLICT (LABELOBJECT | QUERYOBJECT | TYPEOBJECT | SPECIFICOBJECT)*>

<!ELEMENT LABELOBJECT EMPTY>
<!ATTLIST LABELOBJECT
LABELNAME
CDATA
#REQUIRED
RESOLUTION
(REPLACE | REUSE | RENAME)
#REQUIRED
>

<!ELEMENT QUERYOBJECT EMPTY>
<!ATTLIST QUERYOBJECT
QUERYNAME
CDATA
#REQUIRED
RESOLUTION
(REPLACE | REUSE | RENAME)
#REQUIRED
>

<!ELEMENT TYPEOBJECT EMPTY>
<!ATTLIST TYPEOBJECT
CDATA
#REQUIRED
OBJECTTYPENAME
RESOLUTION
REPLACE | REUSE | RENAME)
#REQUIRED
>







<!ELEMENT SPECIFICOBJECT EMPTY>
<!ATTLIST SPECIFICOBJECT
NAME
CDATA
#REQUIRED
DBDNAME
CDATA
#IMPLIED
OBJECTTYPENAME CDATA
#REQUIRED
FOLDERNAME
CDATA
#REQUIRED
REPOSITORYNAME CDATA
#REQUIRED
RESOLUTION
(REPLACE | REUSE | RENAME)
#REQUIRED>

Object Import Control File Parameters

The following table lists pmrep Object Import control file parameters:

278

Element

Attribute Name

Attribute Description

IMPORTPARAMS

CHECKIN_AFTER_IMPORT

Required if versioning is enabled.Checks in

objects when they successfully import.

CHECKIN_COMMENTS

Optional. Applies the comments to the

checked in objects.

APPLY_LABEL_NAME

Optional. Applies the label name on the

imported objects.

RETAIN_GENERATED_VALUE

Required if you use Sequence Generator,

Normalizer, or XML Source Qualifier
transformations. Retains existing Sequence
Generator, Normalizer, and XML Source
Qualifier transformation current values in the
destination.

Chapter 7: Working with pmrep Files

Element

Attribute Name

Attribute Description

COPY_SAP_PROGRAM

Optional. Copies SAP program information

into the target repository.

APPLY_DEFAULT_CONNECTION

Optional. Applies the default connection when

a connection used by a session does not exist
in the target repository. The default
connection is the first connection from the
sorted list of available connections. Finds the
list of connections in the Workflow Manager.

SOURCEFOLDERNAME

Required. Import folder name to match to a

folder in the target repository.

SOURCEREPOSITORYNAME

Required. Repository containing the source

folder.

TARGETFOLDERNAME

Required. Target folder name for matching.

TARGETREPOSITORYNAME

Required. Repository containing the target

folder.

TYPEFILTER

TYPENAME

Optional. Imports the objects from a specific

node, such as sources, targets, or mappings.

RESOLVECONFLICT

LABELOBJECT, QUERYOBJECT,
TYPEOBJECT, AND
SPECIFICOBJECT elements.

You can specify conflict resolutions for

objects.

LABELOBJECT

LABELNAME

Required. Identifies objects by label name for

conflict resolution specification.

RESOLUTION

Required. Replace, Reuse, Rename.

QUERYNAME

Required. Identifies objects from this query for

conflict resolution specification.

RESOLUTION

Required. Replace, Reuse, or Rename.

OBJECTTYPENAME

Required. Object type for this conflict

resolution. For a list of object types, see
Table 7-1 on page 279.

RESOLUTION

Required. Replace, Reuse, or Rename.

NAME

Required. Specific object name for this conflict

resolution.

DBDNAME

Optional. Source DBD to identify source

object.

OBJECTTYPENAME

Required. Object type for this conflict

resolution. For a list of object types, see Table
7-1.

FOLDERNAME

Required. Source folder the containing object.

REPOSITORYNAME

Required. Source repository containing the

object.

RESOLUTION

Required. Replace, Reuse, or Rename.

FOLDERMAP

QUERYOBJECT

TYPEOBJECT

SPECIFICOBJECT

Table 7-1 lists the object types to use with the OBJECTTYPENAME attribute:
Table 7-1. Object Types for OBJECTTYPENAME Attribute
Aggregator

App Multi-Group Source Qualifier

Application Source Qualifier

Assignment

Command

Control

Custom Transformation

Decision

All

Using the Object Import Control File

279

Table 7-1. Object Types for OBJECTTYPENAME Attribute

Event-raise

Event-wait

Expression

External Procedure

Filter

Input Transformation

HTTP Transformation

Joiner

Lookup Procedure

Mapping

Mapplet

MQ Source Qualifier

Normalizer

Output Transformation

Rank

Router

Scheduler

Session

Sequence

SessionConfig

SQL Transform

Sorter

Source Definition

Source Qualifier

Start

Target Definition

Timer

Transaction Control

Union Transformation

Update Strategy

User Defined Function

Workflow

Worklet

XML Generator

XML Parser

XML Source Qualifier

Note: Use the object type All to reuse or replace all objects. For more information about reusing and replacing
objects, see Reusing and Replacing Dependent Objects on page 283.

Object Import Control File Examples

The parameters you specify in the control file code determine the actions that take place when you run the
ObjectImport command in pmrep. The following examples discuss instances in which you use the
ObjectImport command with a control file to import repository objects. The elements and attribute names that
are key to performing the described tasks are designated with comments in the code.
The following table provides a description of sample object import control files:

280

Function

Description

Import source objects.

Use the TYPEFILTER element to import only source objects. For more
information, see Importing Source Objects on page 281.

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 281.

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 282.

Retain Sequence Generator and

Normalizer transformation values.

Use the RETAIN_GENERATED_VALUE attribute of the

IMPORTPARAMS element to retain Sequence Generator and
Normalizer values when you import objects. For more information, see
Retaining Sequence Generator and Normalizer Values on page 282.

Import objects and local shortcut

objects to the same repository.

Use all attributes of the FOLDERMAP element to import objects and

local shortcut objects that reference the objects. For more
information, see Importing Objects and Local Shortcut Objects to the
Same Repository on page 282.

Import shortcut objects from another

repository.

Use all attributes of the FOLDERMAP element to import shortcut

objects from another repository. For more information, see Importing
Shortcut Objects from Another Repository on page 282.

Chapter 7: Working with pmrep Files

Function

Description

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 283.

Import specific objects.

Use the TYPEFILTER element to import specific objects. For more

information, see Importing Specific Objects on page 283.

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 283.

Replace invalid mappings.

Use the QUERYOBJECT element to replace invalid mappings. For

more information, see Replacing Invalid Mappings on page 284.

Rename objects.

Use the RESOLUTION attribute of the SPECIFICOBJECT element to

rename objects. For more information, see Renaming Objects on
page 284.

Copy SAP mappings and SAP

program information.

Use the COPY_SAP_PROGRAM attribute of the IMPORTPARAMS

element to copy SAP mappings and SAP program information. For
more information, see Copying SAP Mappings and SAP Program
Information on page 285.

Apply default connection attributes.

Use the APPLY_DEFAULT_CONNECTION attribute of the

IMPORTPARAMS element to apply default connection attributes. For
more information, see Applying Default Connection Attributes on
page 285.

Resolve object conflicts.

Use the RESOLVECONFLICT element to resolve object conflicts. For

more information, see Resolving Object Conflicts on page 285.

Importing Source Objects

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

<TYPEFILTER TYPENAME ="SOURCE"/>
<RESOLVECONFLICT>
<LABELOBJECT LABELNAME ="Monthend"
RESOLUTION = "REPLACE"/>
<QUERYOBJECT QUERYNAME ="yr_end_qry"
RESOLUTION ="RENAME"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>

Importing Multiple Objects into a Folder

You can import multiple objects into a folder, check them in, and label them. For example, you want to import
the objects to folder SRC_F1 and apply the label LABEL_IMPORT_NEW to the objects.
You might create a control file with the following attributes:
<xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">

<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="NEWOBJECTS" APPLY_LABEL_NAME="LABEL_IMPORT_NEW">
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="TGT_REPO1"/>
</IMPORTPARAMS>

Object Import Control File Examples

281

Checking In and Labeling Imported Objects

You can import objects into a folder, check them in, label them, and resolve the conflict between session
configuration objects. For example, you want to export the objects from folder SRC_F1 and import them into
folder TGT_F1. The Repository Service creates a session configuration in the target folder by default. You
include the APPLY_LABEL_NAME attribute in the IMPORTPARAMS element to label the imported objects,
and the RESOLVECONFLICT element in the control file to resolve the conflict.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">


<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="VERSION1" APPLY_LABEL_NAME="LABEL_IMPORT_NEW">
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="TGT_REPO1"/>
<RESOLVECONFLICT>
<TYPEOBJECT OBJECTTYPENAME="SessionConfig" RESOLUTION="REUSE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>

Retaining Sequence Generator and Normalizer Values

You can retain the values of Sequence Generator and Normalizer transformations when you import objects and
replace all objects in the target folder.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">

<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="VERSION1" APPLY_LABEL_NAME="LABEL_IMPORT_NEW"
RETAIN_GENERATED_VALUE="YES">w
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="TGT_REPO1"/>
<RESOLVECONFLICT>
<TYPEOBJECT OBJECTTYPENAME="ALL" RESOLUTION="REPLACE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>

Importing Objects and Local Shortcut Objects to the Same Repository

You can import objects and their respective local shortcut objects to the same repository. For example, you have
folders named SRC_SHARED_F1 and SRC_NONSHARED_F1. The SRC_NONSHARED_F1 folder is not
shared and contains local shortcut objects that reference objects in the SRC_SHARED_F1 folder. You want to
import the objects to different folders in the target repository, and you want the shortcut objects in folder
TGT_NONSHARED_F1 to point to the objects in TGT_SHARED_F1.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="NO">

<FOLDERMAP SOURCEFOLDERNAME="SRC_SHARED_F1" SOURCEREPOSITORYNAME="SRC__REPO1"
TARGETFOLDERNAME="TGT_SHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_NONSHARED_F1" SOURCEREPOSITORYNAME="SRC_REPO1"
TARGETFOLDERNAME="TGT_NONSHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/>
</IMPORTPARAMS>

Importing Shortcut Objects from Another Repository

You can import objects from other repositories. For example, you have folders in a local repository that contain
shortcuts to objects in a global repository. You want to import the global shortcut objects to a repository that is
registered to the global repository and maintain shortcuts to the original objects in the global repository.
282

Chapter 7: Working with pmrep Files

You might create a control file with the following attributes:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="global objects"
APPLY_LABEL_NAME="LABEL_IMPORT_GLOBAL_SHORTCUT">

<FOLDERMAP SOURCEFOLDERNAME="SRC_SHARED_F1" SOURCEREPOSITORYNAME="SRC_GDR_REPO1"
TARGETFOLDERNAME="SRC_SHARED_F1" TARGETREPOSITORYNAME="SRC_GDR_REPO2"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_NONSHARED_F1" SOURCEREPOSITORYNAME="SRC_LDR_REPO1"
TARGETFOLDERNAME="TGT_NONSHARED_F1" TARGETREPOSITORYNAME="SRC_LDR_REPO2"/>
</IMPORTPARAMS>

Importing Objects to Multiple Folders

You can import objects to multiple folders that were exported from multiple folders. For example, you exported
objects from folders SRC_F1, SRC_F2, and SRC_F3, and you want to import them to target folders TGT_F1,
TGT_F2, TGT_F3 in repository TGT_REPO1.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="mulfolders" APPLY_LABEL_NAME="L1">

<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1"
TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_F2" SOURCEREPOSITORYNAME="SRC_REPO2"
TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_F3" SOURCEREPOSITORYNAME="SRC_REPO3"
TARGETREPOSITORYNAME="TGT_REPO1"/>
<RESOLVECONFLICT>
<TYPEOBJECT OBJECTTYPENAME = "SESSIONCONFIG" RESOLUTION="REUSE"/>
</RESOLVECONFLICT>

target folders TGT_F1, TGT_F2, and

TARGETFOLDERNAME="TGT_F1
TARGETFOLDERNAME="TGT_F2"
TARGETFOLDERNAME="TGT_F3"

</IMPORTPARAMS>

Importing Specific Objects

You can choose the objects you want to import. For example, you exported multiple object types to an XML
file. You want to import only mappings, and respective sources and targets, to a folder.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_TYPEFILTER"
APPLY_LABEL_NAME="LABEL_MAPPING_TYPEFILTER">
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="REPO_EX1_"/>

<TYPEFILTER TYPENAME="MAPPING"/>
</IMPORTPARAMS>

Reusing and Replacing Dependent Objects

You can import sessions, replace the mappings, and reuse the existing sources and targets in the target folder.
For example, you want to replace the mappings and reuse the source definitions, target definitions, and session
configuration objects.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_TYPEFILTER"
APPLY_LABEL_NAME="LABEL_SESSION_TYPEFILTER">

Object Import Control File Examples

283

<FOLDERMAP SOURCEFOLDERNAME="PMREP_CHECKED_OUT" SOURCEREPOSITORYNAME="REPO_EX_1"

TARGETFOLDERNAME="PMREP_CHECKED_OUT_IMPORT_TYPEFILTER_SESSION" TARGETREPOSITORYNAME="REPO_EX_1"/>
<TYPEFILTER TYPENAME="SESSION"/>
<RESOLVECONFLICT>

<TYPEOBJECT OBJECTTYPENAME = "MAPPING" RESOLUTION="REPLACE"/>

<TYPEOBJECT OBJECTTYPENAME = "SOURCE DEFINITION" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME = "TARGET DEFINITION" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME = "SESSIONCONFIG" RESOLUTION="REUSE"/>

<TYPEOBJECT OBJECTTYPENAME = "ALL" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME = "SOURCE DEFINITION" RESOLUTION="REPLACE"/>
<TYPEOBJECT OBJECTTYPENAME = "MAPPING" RESOLUTION="REPLACE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>

Note: When you reuse or replace an object type, the resolution for that object type overrides the resolution for

all object types. The preceding example replaces source definitions and mappings and reuses the remaining
objects. Use the object type All to reuse or replace all objects. For more information about object types, see
Table 7-1 on page 279.

Replacing Invalid Mappings

You can replace invalid mappings and associated child objects that are returned by a query. For example, you
want to replace objects returned by the query QUERY_PARENT_RENAME.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES"
CHECKIN_COMMENTS="PMREP_IMPORT_QUERY_PARENT_REPLACE_CHILD_REUSE"
APPLY_LABEL_NAME="LABEL_QUERY_PARENT_RENAME_CHILD_REUSE">
<FOLDERMAP SOURCEFOLDERNAME="PMREP_CHECKED_OUT" SOURCEREPOSITORYNAME="REPO_EX_1"
TARGETFOLDERNAME="PMREP_CHECKED_OUT" TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>

<QUERYOBJECT QUERYNAME="QUERY_PARENT_RENAME" RESOLUTION="REPLACE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>

Renaming Objects
You can rename specific objects when object conflicts occur. For example, you want to the rename the objects
ADDRESS, ADDRESS1, R_LKP, MAP_MLET, R_S3, WF_RS1. The Repository Service appends the object
names with a number.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_SPECIFICOBJECT_RENAME"
APPLY_LABEL_NAME="LABEL_IMPORT_SPECIFIC_OBJECT_RENAME">
<FOLDERMAP SOURCEFOLDERNAME="SRC_FOLDER1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_FOLDER1"
TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>

<SPECIFICOBJECT NAME="ADDRESS" DBDNAME="sol805" OBJECTTYPENAME="Source Definition"
FOLDERNAME="PMREP_CHECKED_OUT" REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>
<SPECIFICOBJECT NAME="ADDRESS1" OBJECTTYPENAME="Target Definition" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>
<SPECIFICOBJECT NAME="R_LKP" OBJECTTYPENAME="Lookup Procedure" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>
<SPECIFICOBJECT NAME="MAP_MLET" OBJECTTYPENAME="Mapping" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>

284

Chapter 7: Working with pmrep Files

<SPECIFICOBJECT NAME="R_S3" OBJECTTYPENAME="Session" FOLDERNAME="PMREP_CHECKED_OUT"

REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>
<SPECIFICOBJECT NAME="WF_RS1" OBJECTTYPENAME="Workflow" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="RENAME"/>
</RESOLVECONFLICT></IMPORTPARAMS>

Copying SAP Mappings and SAP Program Information

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

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

Applying Default Connection Attributes

You can apply a default connection attribute to a session if a connection is not present in the target repository.
For example, no connection exists in target repository REPO_EX_1.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">

<IMPORTPARAMS CHECKIN_AFTER_IMPORT="NO" APPLY_DEFAULT_CONNECTION="YES">
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>
<SPECIFICOBJECT NAME="R_S3" OBJECTTYPENAME="Session" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="REPLACE"/>
<RESOLVECONFLICT>
</IMPORTPARAMS>

Resolving Object Conflicts

You can resolve object conflicts for labeled objects in the target repository. For example, you have mappings,
mapplets, sources, and targets labeled LBL_MPNG_MPLTS_SRCS_TGTS. You want to replace these objects
and label them REPLACE_LBL_MPNG_MPLTS_SRCS_TGTS and reuse all transformations.
You might create a control file with the following attributes:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE IMPORTPARAMS SYSTEM "impcntl.dtd">
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES" CHECKIN_COMMENTS="PMREP_IMPORT_LABEL_REPLACE"
APPLY_LABEL_NAME="REPLACE_LBL_MPNG_MPLTS_SRCS_TGTS" >
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1" TARGETFOLDERNAME="TGT_F1"
TARGETREPOSITORYNAME="REPO_EX_1"/>

<RESOLVECONFLICT>
<LABELOBJECT LABELNAME="LBL_MPNG_MPLTS_SRCS_TGTS" RESOLUTION="REPLACE"/>
<TYPEOBJECT OBJECTTYPENAME="Lookup Procedure" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Stored Procedure" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Expression" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Filter" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Aggregator" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Rank" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Normalizer" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Router" RESOLUTION="REUSE"/>

Object Import Control File Examples

285

<TYPEOBJECT OBJECTTYPENAME="Sequence" RESOLUTION="REUSE"/>

Using the Deployment Control File

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

The following is a sample of the depcntl.dtd file:

<!ELEMENT DEPLOYPARAMS (DEPLOYFOLDER?, DEPLOYGROUP?)>
<!ATTLIST DEPLOYPARAMS
DEFAULTSERVERNAME
CDATA
#IMPLIED
COPYPROGRAMINFO
(YES | NO) "YES"
COPYMAPVARPERVALS
(YES | NO) "NO"
COPYWFLOWVARPERVALS (YES | NO) "NO"
COPYWFLOWSESSLOGS
(YES | NO) "NO"
COPYDEPENDENCY
(YES | NO) "YES"
LATESTVERSIONONLY
(YES | NO) "NO"
CHECKIN_COMMENTS
CDATA
#IMPLIED
DEPLOYTIMEOUT
CDATA
"-1"
RETAINGENERATEDVAL
(YES | NO) "YES"
RETAINSERVERNETVALS (YES | NO) "YES">
COPYDEPLOYMENTGROUP (YES | NO) "NO">

<!ELEMENT DEPLOYFOLDER (REPLACEFOLDER?, DEPLOYEDFOLDEROWNER?, OVERRIDEFOLDER*)>
<!ATTLIST DEPLOYFOLDER
NEWFOLDERNAME
CDATA
#IMPLIED>

<!ELEMENT REPLACEFOLDER EMPTY>
<!ATTLIST REPLACEFOLDER
FOLDERNAME
CDATA
RETAINMAPVARPERVALS
(YES |
RETAINWFLOWVARPERVALS (YES |
RETAINWFLOWSESSLOGS
(YES |
MODIFIEDMANUALLY
(YES |
RETAINORIGFOLDEROWNER (YES |

NO)
NO)
NO)
NO)
NO)

#REQUIRED
"NO"
"YES"
"NO"
"NO"
"NO">

<!ELEMENT OVERRIDEFOLDER EMPTY>
<!ATTLIST OVERRIDEFOLDER
SOURCEFOLDERNAME
CDATA
#REQUIRED
SOURCEFOLDERTYPE
(LOCAL | GLOBAL) "LOCAL"
#REQUIRED
TARGETFOLDERNAME
CDATA
TARGETFOLDERTYPE
(LOCAL | GLOBAL) "LOCAL"
MODIFIEDMANUALLY
(YES | NO)
"NO"

<!ELEMENT DEPLOYGROUP (REPLACEDG?, TARGETDGOWNER?, OVERRIDEFOLDER*, APPLYLABEL?)>
<!ATTLIST DEPLOYGROUP
CLEARSRCDEPLOYGROUP (YES | NO) "NO">
NEWDEPLOYGROUPNAME
CDATA #IMPLIED

286

Chapter 7: Working with pmrep Files

<!--labels used to apply on

<!ELEMENT APPLYLABEL EMPTY>
<!ATTLIST APPLYLABEL
SOURCELABELNAME
SOURCEMOVELABEL
TARGETLABELNAME
TARGETMOVELABEL

the src objects and deployed objects-->

CDATA
(YES | NO)
CDATA
(YES | NO)

#IMPLIED
"NO"
#IMPLIED
"NO">

<!ELEMENT DEPLOYEDFOLDEROWNER EMPTY>
<!ATTLIST DEPLOYEDFOLDEROWNER
#IMPLIED
USERNAME
CDATA
SECURITYDOMAIN
CDATA
#IMPLIED
GROUPNAME
CDATA
#IMPLIED>

<!ELEMENT REPLACEDG EMPTY>
<!ATTLIST REPLACEDG
DGNAME
CDATA
#REQUIRED
SECURITYDOMAIN
CDATA
#IMPLIED

<!ELEMENT TARGETOWNER EMPTY>
<!ATTLIST TARGETOWNER
USERNAME
CDATA
#IMPLIED
SECURITYDOMAIN
CDATA
#IMPLIED

Deployment Control File Parameters

The following table lists pmrep deployment control file parameters:
Element

Attribute Name

Attribute Description

DEPLOYPARAMS
(Use with DeployFolder
and
DeployDeploymentGroup)

DEFAULTSERVERNAME

Optional. Integration Service registered

in the target repository to run
workflows. For any deployment, you
can specify one default server name.

COPYPROGRAMINFO

Optional. Copies SAP installed ABAP

program.

COPYMAPVARPERVALS

Optional. Copies mapping variable

persistent values.

COPYWFLOWVARPERVALS

Optional. Copies workflow variable

persistent values.

COPYWFLOWSESSLOGS

Optional. Copies workflow logs.

COPYDEPENDENCY

Optional. Copies dependency

information for objects in mappings.

COPYDEPLOYMENTGROUP

Optional. Copies the deployment group

along with the objects in the
deployment group to the target
repository.

VALIDATETARGETREPOSITORY

Optional. Validates objects in the target

repository.

LATESTVERSIONONLY

Optional. Copies the latest version.

CHECKIN_COMMENTS

Optional. Overrides the default

comment and adds a comment in the
target repository when you copy or
deploy an object. You must set
LATESTVERSIONONLY to true to use
this attribute.

Using the Deployment Control File

287

Element

Attribute Name

Attribute Description

DEPLOYTIMEOUT

Optional. Period of time (in seconds)

that pmrep attempts to acquire locks on
objects in the target repository. A value
of 0 fails the copy operation
immediately if pmrep cannot obtain a
lock. A value of -1 instructs pmrep to
wait indefinitely until it acquires locks
or the user cancels the operation.
Default is -1.

RETAINGENERATEDVAL

Optional. Keeps the current value for

Sequence Generator or Normalizer
transformations.

RETAINSERVERNETVALS

Optional. Retains server-networkrelated values in tasks.

DEPLOYFOLDER
(Use with DeployFolder)

NEWFOLDERNAME

Optional. Creates a folder with this

name.

REPLACEFOLDER
(Use with DeployFolder)

FOLDERNAME

Required. Names the folder after

replacing it.

RETAINMAPVARPERVALS

Optional. Retains mapping variable

persistent values in the target.

RETAINFLOWVARPERVALS

Optional. Retains workflow variable

persistent values.

RETAINWFLOWSESSLOGS

Optional. Retains workflow session

logs in the target.

MODIFIEDMANUALLY

Optional. Compares folders if objects in

the target folder have been created or
modified since the previous
deployment.

RETAINORIGFOLDEROWNER

Optional. Retains the existing folder

owner. pmrep ignores any information
provided in the
DEPLOYEDFOLDEROWNER element.

SOURCEFOLDERNAME

Required. If deploying a folder,

specifies the current folder that
shortcuts point to.
If deploying a deployment group,
specifies the following folders:
- Folder or folders that shortcuts point
to
- Folder or folders containing the
deployment group objects

SOURCEFOLDERTYPE

Optional. If deploying a folder, specifies

the type of folder that shortcuts point
to. Use local or global shortcuts.

TARGETFOLDERNAME

Required. If deploying a folder,

specifies the folder that shortcuts point
to.
If deploying a deployment group,
specifies the following folders:
- Folder or folders that shortcuts point
to
- Folder or folders containing the
deployment group objects

TARGETFOLDERTYPE

Optional. If deploying a folder, specifies

the type of folder that shortcuts point
to. Use local or global shortcuts.

OVERRIDEFOLDER
(Use with DeployFolder
and
DeployDeploymentGroup)

288

Chapter 7: Working with pmrep Files

Element

DEPLOYGROUP
(Use with
DeployDeploymentGroup)

REPLACEDG

TARGETOWNER

APPLYLABEL
(Use with
DeployDeploymentGroup)

DEPLOYEDFOLDEROWN
ER
(Use with DeployFolder
and
DeployDeploymentGroup)

Attribute Name

Attribute Description

MODIFIEDMANUALLY

Optional. Compares folders if objects in

the target folder have been created or
modified since the previous
deployment. Use this attribute only with
the DeployDeploymentGroup
command.

CLEARSRCDEPLOYGROUP

Optional. Removes objects from the

source group after deploying.

NEWDEPLOYGROUPNAME

Optional. Creates a deployment group

with this name. Ignored if REPLACEDG
is specified. Default is the source
deployment group name.

DGNAME

Optional. Name of the deployment

group to be replaced.

RETAINORIGINALOWNER

Optional. Specifies whether to retain

the owner of the deployment group
being replaced in the target repository.

USERNAME

Optional. Owner of the copied

deployment group. Default is the owner
of the source deployment group.

SECURITYDOMAIN

Optional. Security domain of the target

deployment group.

SOURCELABELNAME

Optional. Applies a label to all the

objects in the source group.

SOURCEMOVELABEL

Optional. Moves the label from a

different version of the object in the
source group to the deployment group
version of the object. If the Repository
Agent detects the label is applied to
another version of the same object, you
can choose to move the label to the
selected version of the object.

TARGETLABELNAME

Optional. Applies a label to all the

objects deployed to the target
repository.

TARGETMOVELABEL

Optional. Moves the label from a

different version of the object in the
target group to the deployment group
version of the object. If the Repository
Agent detects the label is applied to
another version of the same object, you
can choose to move the label to the
latest version of the object.

USERNAME

Optional. Owner of the deployed folder

or deployment group in the target
repository.

SECURITYDOMAIN

Optional. Name of the security domain

that the owner of the deployed folder or
deployment group belongs to.

GROUPNAME

Optional. Group owner of the deployed

folder or deployment group in the
target repository.

Using the Deployment Control File

289

Deployment Control File Examples

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

Deploying the Latest Version of a Folder

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

Deploying the Latest Version of a Deployment Group

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

Listing Multiple Source and Target Folders

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

290

The folder or folders that shortcuts point to

The folder or folders containing the deployment group objects

Chapter 7: Working with pmrep Files

When you run the pmrep command, DeployDeploymentGroup, the deploy process picks the right target folder
to use after checking the objects in the deployment group.
For example, if a deployment group contains objects in two folders with shortcuts to a third folder, you can
create a control file with three occurrences of OVERRIDEFOLDER. The following sample control file deploys
a deployment group that contains objects in the folders OBJECTFOLDER1 and OBJECTFOLDER2 that
contain shortcuts pointing to the folder SHAREDSHORTCUT:
<!DOCTYPE DEPLOYPARAMS SYSTEM "depcntl.dtd">
<DEPLOYPARAMS DEFAULTSERVERNAME="dg_sun_71099"
COPYPROGRAMINFO="YES"
COPYMAPVARPERVALS="YES"
COPYWFLOWVARPERVALS="YES"
COPYWFLOWSESSLOGS="NO"
COPYDEPENDENCY="YES"
LATESTVERSIONONLY="YES"
RETAINGENERATEDVAL="YES"
RETAINSERVERNETVALS="YES">
<DEPLOYGROUP CLEARSRCDEPLOYGROUP="NO">
<OVERRIDEFOLDER SOURCEFOLDERNAME="OBJECTFOLDER1"
SOURCEFOLDERTYPE="LOCAL"
TARGETFOLDERNAME="OBJECTFOLDER1"
TARGETFOLDERTYPE="LOCAL"/>
<OVERRIDEFOLDER SOURCEFOLDERNAME="OBJECTFOLDER2"
SOURCEFOLDERTYPE="LOCAL"
TARGETFOLDERNAME="OBJECTFOLDER2"
TARGETFOLDERTYPE="LOCAL"/>
<OVERRIDEFOLDER SOURCEFOLDERNAME="SHAREDSHORTCUTS"
SOURCEFOLDERTYPE="GLOBAL"
TARGETFOLDERNAME="SHAREDSHORTCUTS"
TARGETFOLDERTYPE="GLOBAL"/>
</DEPLOYGROUP>
</DEPLOYPARAMS>

Tips
Use the -n option when you use the pmrep commands Updatesrcprefix or Updatetargprefix.
When you include the -n option, you must enter the name of the source or target instance for the -t option.
The source or target instance name must match the name displayed in the session properties or the name output
by the Listtablesbysess command.
Use the -n option to use the Listtablesbysess command with the Updatesrcprefix or Updatetargprefix commands
in a shell script if the source and target instance names match. Also, use the -n option to update a source even if
the session uses a shortcut to a mapping.
When using the pmrep command ListObjects, enter a character or set of characters that is not used in repository
object names for the column separator, end of record indicator, and end of listing indicator.
When you enter characters to separate records and columns, and to indicate the end of the listing, use
characters that are not included in repository object names. This helps you use a shell script to parse the object
metadata.
In pmrep, use the -v option when restoring a repository that uses an external directory service for user management.
When you include the -v option with Restore, you can retain the external directory service registration for the
repository. If you do not enter this option with the valid administrator user name and password, the restored
repository defaults to repository authentication mode and you lose the association between login names and
user names.

Tips

291

292

Chapter 7: Working with pmrep Files

INDEX

A
AbortTask (pmcmd)
description 187
AbortWorkflow (pmcmd)
description 189
AddAlertUser (infacmd)
description 12
AddDomainLink (infacmd)
description 13
AddDomainNode (infacmd)
description 14
AddGroupPermission (infacmd)
description 15
AddGroupPrivilege (infacmd)
description 16
AddLicense (infacmd)
description 18
AddNodeResource (infacmd)
description 19
AddRolePrivilege (infacmd)
description 20
AddServiceLevel (infacmd)
description 21
AddToDeploymentGroup (pmrep)
description 219
AddUserPermission (infacmd)
description 22
AddUserPrivilege (infacmd)
description 23
AddUserToGroup (infacmd)
description 25
alerts
configuring SMTP settings using infacmd 161
listing SMTP settings using infacmd 107
listing subscribed users infacmd 89
subscribing to using infacmd 12
unsubscribing from using infacmd 113
application services
disabling using infacmd 67
enabling using infacmd 72
getting status using infacmd 83
removing using infacmd 124
ApplyLabel (pmrep)
description 220
AssignedToLicense (infacmd)
description 26
AssignISToMMService (infacmd)
description 27

AssignLicense (infacmd)
description 28
AssignPermission (pmrep)
description 222
AssignRoletoGroup (infacmd)
description 29
AssignRoletoUser (infacmd)
description 30
AssignRSToWSHubService (infacmd)
description 31

B
BackUp (pmrep)
description 223
BackupDARepositoryContents (infacmd)
description 32
BackupDomain (infasetup)
description 169

C
ChangeOwner (pmrep)
description 224
CheckIn (pmrep)
description 224
CleanUp (pmrep)
description 225
ClearDeploymentGroup (pmrep)
description 225
command line mode for pmcmd
connecting 183
concurrent workflows
starting from command line 206
stopping from command line 210
Connect (pmcmd)
description 190
Connect (pmrep)
description 225
connect string
examples 219
syntax 219
connectivity
connect string examples 219
control file
deployment 286
object import 277
ObjectImport XML example 280

293

ConvertLogFile (infacmd)
description 33
CPU profile
calculating using infacmd 131
Create (pmrep)
description 227
CreateConnection (pmrep)
description 227
CreateDARepositoryContents (infacmd)
description 34
CreateDeploymentGroup (pmrep)
description 231
CreateFolder (infacmd)
description 35
CreateFolder (pmrep)
description 231
CreateGrid (infacmd)
description 36
CreateGroup (infacmd)
description 37
CreateGroup (pmrep)
description 232
CreateIntegrationService (infacmd)
description 38
CreateLabel (pmrep)
description 232
CreateMMService (infacmd)
description 44
CreateOSProfile (infacmd)
description 47
CreateReportingService (infacmd)
description 49, 52
CreateRole (infacmd)
description 55
CreateRTMService (infacmd)
description 56
CreateSAPBWService (infacmd)
description 58
CreateUser (infacmd)
description 61
CreateWSHubService (infacmd)
description 62

D
Data Analyzer repository
backing up contents using infacmd 32
creating contents using infacmd 34
deleting contents using infacmd 65
restoring contents using infacmd 130
upgrading contents using infacmd 163
upgrading users and groups using infacmd 164
DB2
See IBM DB2
DefineDomain (infasetup)
description 170
DefineGatewayNode (infasetup)
description 173
DefineWorkerNode (infasetup)
description 175
Delete (pmrep)
description 233

294

Index

DeleteConnection (pmrep)
description 233
DeleteDARepositoryContents (infacmd)
description 65
DeleteDeploymentGroup (pmrep)
description 234
DeleteDomain (infasetup)
description 176
DeleteFolder (pmrep)
description 234
DeleteLabel (pmrep)
description 235
DeleteObject (pmrep)
description 235
depcntl.dtd
listing 286
DeployDeploymentGroup (pmrep)
description 235
DeployFolder (pmrep)
description 237
deploying objects
depcntl.dtd 286
deployment control file
description 286
deployment groups
listing multiple folders 290
DisableNodeResource (infacmd)
description 65
DisableService (infacmd)
description 67
DisableServiceProcess (infacmd)
description 68
DisableUser (infacmd)
description 69
Disconnect (pmcmd)
description 191
domains
backing up using infasetup 169
creating using infasetup 170
deleting using infasetup 176
linking using infacmd 13
listing linked domains using infacmd 92
listing properties using infacmd 93
removing links using infacmd 114
restoring using infasetup 178
updating properties using infacmd 145
DTD file
plug-in template 261

E
EditUser (infacmd)
description 70
EditUser (pmrep)
description 238
EnableNodeResource (infacmd)
description 71
EnableService (infacmd)
description 72
EnableServiceProcess (infacmd)
description 73

EnableUser (infacmd)
description 74
environment variables
configuring for command-line programs 3
INFA_CLIENT_RESILIENCE_TIMEOUT 4
INFA_CODEPAGENAME 5
INFA_DEFAULT_DATABASE_PASSWORD 6
INFA_DEFAULT_DOMAIN 6
INFA_DEFAULT_DOMAIN_PASSWORD 7
INFA_DEFAULT_DOMAIN_USER 8
INFA_REPCNX_INFO 8
INFATOOL_DATEFORMAT 9
error messages
fetching using infacmd 77
ExecuteQuery (pmrep)
description 238
Exit (pmrep)
description 239
ExportUsersAndGroups (infacmd)
description 75
external security modules
registering 261
unregistering 267

F
FindCheckout (pmrep)
description 239
folders
creating using infacmd 35
deleting 234
deploying 237
getting information about using infacmd 76
listing using infacmd 94
modifying 253
moving objects between using infacmd 110
moving using infacmd 109
removing using infacmd 114
updating description using infacmd 147

G
gateway
updating information using infacmd 148
GetConnectionDetails (pmrep)
description 240
GetFolderInfo (infacmd)
description 76
GetLastError (infacmd)
description 77
GetLog (infacmd)
description 78
GetNodeName (infacmd)
description 80
GetRunningSessionsDetails (pmcmd)
description 192
GetServiceDetails (pmcmd)
description 193
GetServiceOption (infacmd)
description 81
GetServiceProcessOption (infacmd)
description 82

GetServiceProcessStatus (infacmd)
description 83
GetServiceProperties (pmcmd)
description 194
GetServiceStatus (infacmd)
description 83
GetSessionLog (infacmd)
description 84
GetSessionStatistics (pmcmd)
description 195
GetTaskDetails (pmcmd)
description 196
GetWorkflowDetails (pmcmd)
description 198
GetWorkflowLog (infacmd)
description 86
grids
creating using infacmd 36
listing nodes using infacmd 95
removing using infacmd 115
updating assigned nodes using infacmd 148
groups
creating using infacmd 37
exporting using infacmd 75
importing using infacmd 88
listing using infacmd 90
removing using infacmd 116

H
Help (infacmd)
description 88
Help (pmcmd)
description 199
Help (pmrep)
description 240

I
IBM DB2
connect string example 219
impcntl.dtd
description 277
importing objects
impcntl.dtd 277
ObjectImport XML example 280
ImportUsersAndGroups (infacmd)
description 88
INFA_CLIENT_RESILIENCE_TIMEOUT
configuring 4
INFA_CODEPAGENAME
configuring 5
INFA_DEFAULT_DATABASE_PASSWORD
configuring 6
INFA_DEFAULT_DOMAIN
configuring 6
INFA_DEFAULT_DOMAIN_PASSWORD
configuring 7
INFA_DEFAULT_DOMAIN_USER
configuring 8
INFA_REPCNX_INFO
configuring 8
Index

295

infacmd
alerts, configuring SMTP settings 161
alerts, listing SMTP settings 107
alerts, listing subscribed users 89
alerts, subscribing to 12
alerts, unsubscribing from 113
CPU profile, calculating 131
creating Metadata Manager Service using infacmd 44
Data Analyzer repository, backing up contents 32
Data Analyzer repository, creating contents 34
Data Analyzer repository, deleting contents 65
Data Analyzer repository, restoring contents 130
Data Analyzer repository, upgrading contents 163
Data Analyzer repository, upgrading users and groups 164
disassociating Metadata Manager Service 139
domains, linking 13
domains, listing linked domains 92
domains, listing properties 93
domains, removing links 114
domains, updating properties 145
error messages, fetching 77
folders, creating 35
folders, getting information about 76
folders, listing 94
folders, moving 109
folders, moving objects between 110
folders, removing 114
folders, updating description 147
gateway information, updating 148
grids, creating 36
grids, listing nodes 95
grids, removing 115
grids, updating assigned nodes 148
groups, assigning privileges to 16
groups, creating 37
groups, listing 90
groups, listing privileges for 95
groups, removing 116
groups, removing privileges from 117
help 88
Integration Service for Metadata Manager Service, configuring 27
Integration Service options 40, 50
Integration Services, creating 38
Integration Services, updating 149
LDAP authentication, setting up 132
LDAP connection, listing 96
LDAP server configuration, listing 101
LDAP server configuration, updating 134
licenses, adding 18
licenses, assigning to services 28
licenses, displaying information 135
licenses, listing 97
licenses, listing services 26
licenses, removing 118
licenses, unassigning 140
licenses, updating 151
log events, fetching 78
log events, purging 112
log files, converting to binary 33
Metadata Manager Service properties, updating 151
node names, fetching 80
nodes, adding to domains 14
nodes, disassociating from domains 144
296

Index

nodes, listing 99, 105

nodes, listing options 98
nodes, removing 119
nodes, shutting down 136
nodes, switching from gateway to worker 138
nodes, switching from worker to gateway 137
nodes, updating 152
operating system profile, creating 47
operating system profile, listing 100
operating system profile, removing 121
operating system profile, updating 154
passwords, resetting user passwords 129
passwords, updating 146
permissions, assigning to a group 15
permissions, assigning to a user 22
pinging objects 111
Reference Table Manager Service, creating 56
Reference Table Manager Service, updating 157
Reporting Service, creating 49, 52
Reporting Service, updating 155
Repository Service options 53
Repository Services, updating 156
resources, adding to nodes 19
resources, disabling on nodes 65
resources, enabling on nodes 71
resources, listing for nodes 100
resources, removing from nodes 120
return codes 12
roles, adding privileges to 20
roles, assigning to a group 29
roles, assigning to a user 30
roles, creating 55
roles, listing 91
roles, listing privileges for 102
roles, removing 122
roles, removing from a group 141
roles, removing from user 142
roles, removing privileges from 123
running in a mixed-version domain 12
SAP BW Service options 60
SAP BW service process options 60
SAP BW Services, creating 58
SAP BW Services, updating 158
security domains, listing 103
service levels, adding 21
service levels, listing 104
service levels, removing 125
service levels, updating 159
service options, fetching 81
service process options 43
service process options, fetching 82
service process status, fetching 83
service processes, disabling 68
service processes, enabling 73
service processes, updating 160
service status, fetching 83
services, disabling 67
services, enabling 72
services, listing 106
services, listing privileges for 105
services, removing 124
session logs, fetching 84
users and groups, exporting 75

users and groups, importing 88

users, adding privileges to 23
users, adding to a group 25
users, creating 61
users, disabling 69
users, editing 70
users, enabling 74
users, listing 91
users, listing privileges for 108
users, removing 126
users, removing from a group 127
users, removing privileges from 128
Web Services Hub service options 64
Web Services Hub, associating a repository 31
Web Services Hub, creating 62
Web Services Hub, disassociating a repository 143
Web Services Hub, updating 162
workflow logs, fetching 86
infasetup
domains, backing up 169
domains, defining 170
domains, deleting 176
domains, restoring 178
gateway nodes, defining 173
gateway nodes, updating 180
return codes 168
running in a mixed-version domain 167
worker nodes, defining 175
worker nodes, updating 181
INFATOOL_DATEFORMAT
configuring 9
Integration Service
creating using infacmd 38
disabling using infacmd 67
enabling using infacmd 72
getting status using infacmd 83
removing using infacmd 124
updating using infacmd 149
interactive mode for pmcmd
connecting 185
setting defaults 185

K
KillUserConnection (pmrep)
description 241

L
labels
creating using pmrep 232
deleting 235
LDAP authentication
setting up using infacmd 132
LDAP connection
listing using infacmd 96
LDAP server configuration
listing using infacmd 101
updating using infacmd 134
licenses
adding using infacmd 18
assigning using infacmd 28

displaying using infacmd 135

listing services using infacmd 26
listing using infacmd 97
removing using infacmd 118
unassigning using infacmd 140
updating using infacmd 151
ListAlertUsers (infacmd)
description 89
ListAllGroups (infacmd)
description 90
ListAllRoles (infacmd)
description 91
ListAllUsers (infacmd)
description 91
ListAllUsers (pmrep)
description 242
ListConnections (pmrep)
description 241
ListDomainLinks (infacmd)
description 92
ListDomainOptions (infacmd)
description 93
ListFolders (infacmd)
description 94
ListGridNodes (infacmd)
description 95
ListGroupPrivileges (infacmd)
description 95
ListLicenses (infacmd)
description 97
ListNodeOptions (infacmd)
description 98
ListNodeResources (infacmd)
description 100
ListNodes (infacmd)
description 99
ListObjectDependencies (pmrep)
description 242
ListObjects (pmrep)
description 243
listing folders 247
transformation types 246
ListOSProfiles (infacmd)
description 100
ListRepositoryLDAPConfiguration (infacmd)
description 101
ListRolePrivileges (infacmd)
description 102
ListSecurityDomains (infacmd)
description 103
ListServiceLevels (infacmd)
description 104
ListServiceNodes (infacmd)
description 105
ListServicePrivileges (infacmd)
description 105
ListServices (infacmd)
description 106
ListSMTPOptions (infacmd)
description 107
ListTablesBySess (pmrep)
description 247

Index

297

ListtLDAPConnectivity (infacmd)
description 96
ListUserConnections (pmrep)
description 248
ListUserPrivileges (infacmd)
description 108
local parameter files
using with pmcmd StartWorkflow 207
log events
converting using infacmd 33
fetching using infacmd 78
purging using infacmd 112
truncating using pmrep 264

M
MassUpdate (pmrep)
description 249
Microsoft SQL Server
connect string syntax 219
mixed-version domain
running infacmd 12
running infasetup 167
running pmcmd 183
running pmrep 217
ModifyFolder (pmrep)
description 253
MoveFolder (infacmd)
description 109
MoveObject (infacmd)
description 110

N
native connect string
See connect string
nodes
adding to domains using infacmd 14
defining gateway using infasetup 173
defining worker using infasetup 175
disassociating from domains infacmd 144
fetching names using infacmd 80
listing options using infacmd 98
listing using infacmd 105
switching from gateway to worker infacmd 138
switching from worker to gateway infacmd 137
updating gateway using infasetup 180
updating worker using infasetup 181
Notify (pmrep)
description 254

O
object import control file
description 277
ObjectExport (pmrep)
description 255
ObjectImport (pmrep)
description 256
objects
checking in 224

298

deleting 235
exporting 255
importing 256
operating system profile
creating using infacmd 47
listing using infacmd 100
removing using infacmd 121
updating using infacmd 154
Oracle
connect string syntax 219
OVERRIDEFOLDER
sample control file 290

Index

parameter files
using with pmcmd StartTask 205
using with pmcmd StartWorkflow 207
passwords
changing using infacmd 146
encrypting 9
resetting user passwords using infacmd 129
permissions
See also Administrator Guide
See also Repository Guide
assigning to a group using infacmd 15
assigning to a user using infacmd 22
assigning using pmrep 222
persistent input file
creating with pmrep 276
Ping (infacmd)
description 111
PingService (pmcmd)
description 200
plug-ins
XML templates 261
pmcmd
command line mode 183
folders, designating for executing commands 203
folders, designating no default folder 212
Integration Service, connecting to 190
Integration Service, disconnecting from 191
Integration Service, getting properties 194
Integration Service, pinging 200
interactive mode 185
interactive mode, exiting from 191
nowait mode, setting 203
parameter files 205, 207
return codes 184
running in a mixed-version domain 183
script files 186
service settings, getting 204
session statistics, getting 195
sessions, getting details about 192
tasks, aborting 187
tasks, completing before returning the prompt 212
tasks, getting details about 193, 196
tasks, starting 204
tasks, stopping 208
version, displaying 212
wait mode, setting 203
workflows, aborting 189

workflows, determining if running 214

workflows, getting details about 193, 198
workflows, recovering 200
workflows, removing from a schedule 211
workflows, scheduling 202
workflows, starting 206
workflows, stopping 210
pmpasswd
encrypting passwords 9
syntax 9
pmrep
checked-out objects, listing 239
checkouts, undoing 265
command line mode 217
connection details, listing 240
connection information, showing 263
connection name, changing 264
connections, creating 227
connections, deleting 233
connections, listing 241
connections, updating 268
deployment control file parameters 287
deployment groups, adding objects to 219
deployment groups, clearing objects from 225
deployment groups, creating 231
deployment groups, deleting 234
deployment groups, deploying 235
deployment, rolling back 262
email addresses, updating 269
folder properties, modifying 253
folders, creating 231
folders, deleting 234
folders, deploying 237
folders, listing 247
folders, modifying properties 253
groups, creating 232
help 240
interactive mode 218
interactive mode, exiting 239
interactive mode, exiting from 239
labels, applying 220
labels, creating 232
labels, deleting 235
logs, deleting 264
notification messages, sending 254
object dependencies, listing 242
object import control parameters 278
object versions, purging 257
objects, changing ownership 224
objects, checking in 224
objects, deleting 235
objects, exporting 255
objects, importing 256
objects, listing 243
objects, validating 272
overview 217
permission, assigning 222
persistent input files, creating 276
plug-ins, registering 259
plug-ins, unregistering 266
queries, executing 238
repositories, backing up 223
repositories, connecting to 225

repositories, creating 227

repositories, deleting 233
repositories, registering 258
repositories, restoring 261
repositories, unregistering 265
repository connection file, specifying 8
repository statistics, updating 271
resources, cleaning up 225
running in a mixed-version domain 217
script files 219
scripts, running 263
sequence values, updating 269
table owner names, updating 270
tables, listing by session 247
target table name prefixes, updating 271
user connections, listing 248
user connections, terminating 241
user properties, editing 238
users, listing 242
version information, displaying 274
post-session email
updating addresses with pmrep 269
privileges
adding to groups using infacmd 16
adding to roles using infacmd 20
assigning to users using infacmd 23
listing for a group using infacmd 95
listing for a role using infacmd 102
listing for a user using infacmd 108
listing for services using infacmd 105
removing from a group using infacmd 117
removing from a role using infacmd 123
removing from a user using infacmd 128
PurgeLog (infacmd)
description 112
PurgeVersion (pmrep)
description 257

Q
queries
executing 238

R
RecoverWorkflow (pmcmd)
description 200
Reference Table Manager Service
creating using infacmd 56
updating using infacmd 157
Register (pmrep)
description 258
registering
plug-in using pmrep 259
security module using pmrep 261
RegisterPlugin (pmrep)
description 259
RemoveAlertUser (infacmd)
description 113
RemoveDomainLink (infacmd)
description 114

Index

299

RemoveFolder (infacmd)
description 114
RemoveGrid (infacmd)
description 115
RemoveGroup (infacmd)
description 116
RemoveGroupPrivilege (infacmd)
description 117
RemoveLicense (infacmd)
description 118
RemoveNode (infacmd)
description 119
RemoveNodeResource (infacmd)
description 120
RemoveOSProfile (infacmd)
description 121
RemoveRole (infacmd)
description 122
RemoveRolePrivilege (infacmd)
description 123
RemoveService (infacmd)
description 124
RemoveServiceLevel (infacmd)
description 125
RemoveUser (infacmd)
description 126
RemoveUserFromGroup (infacmd)
description 127
RemoveUserPrivilege (infacmd)
description 128
Reporting Service
creating using infacmd 49, 52
updating using infacmd 155
repositories
backing up using pmrep 223
connecting to using pmrep 225
creating relational 227
deleting details from 264
registering 258
unregistering 265
Repository Service
disabling using infacmd 67
enabling using infacmd 72
getting status using infacmd 83
removing using infacmd 124
updating using infacmd 156
ResetPassword (infacmd)
description 129
resources
defining using infacmd 19
disabling using infacmd 65
enabling using infacmd 71
removing using infacmd 120
viewing using infacmd 100
Restore (pmrep)
description 261
RestoreDARepositoryContents (infacmd)
description 130
RestoreDomain (infasetup)
description 178
restoring
repositories using pmrep Restore 261

300

Index

return codes
infacmd 12
infasetup 168
pmcmd 184
roles
assigning to a group using infacmd 29
assigning to a user using infacmd 30
creating using infacmd 55
listing using infacmd 91
removing from a group using infacmd 141
removing from a user using infacmd 142
removing using infacmd 122
RollbackDeployment (pmrep)
description 262
Run (pmrep)
description 263
RunCPUProfile (infacmd)
description 131

S
SAP BW Service
creating using infacmd 58
updating using infacmd 158
ScheduleWorkflow (pmcmd)
description 202
script files
running 263
using for pmrep commands 219
security domains
listing using infacmd 103
service levels
listing using infacmd 104
removing using infacmd 125
updating using infacmd 159
service options
fetching using infacmd 81
service process options
fetching using infacmd 82
services
listing using infacmd 106
session logs
fetching using infacmd 84
SetFolder (pmcmd)
description 203
SetLDAPConnectivity (infacmd)
description 132
SetNoWait (pmcmd)
description 203
SetRepositoryLDAPConfiguration (infacmd)
description 134
SetWait (pmcmd)
description 203
ShowConnectionInfo (pmrep)
description 263
ShowLicense (infacmd)
description 135
ShowSettings (pmcmd)
description 204
ShutdownNode (infacmd)
description 136

StartTask (pmcmd)
description 204
using a parameter file 205
StartWorkflow (pmcmd)
description 206
using a parameter file 207
statistics
updating repository 271
StopTask (pmcmd)
description 208
StopWorkflow (pmcmd)
description 210
SwitchConnection (pmrep)
description 264
SwitchToGatewayNode (infacmd)
description 137
SwitchToWorkerNode (infacmd)
description 138
syntax
command line programs 2

T
table owner name
updating with pmrep 270
TruncateLog (pmrep)
description 264

U
UnassignISMMService (infacmd)
description 139
UnassignLicense (infacmd)
description 140
UnAssignRoleFromGroup (infacmd)
description 141
UnassignRoleFromUser (infacmd)
description 142
UnassignRSWSHubService (infacmd)
description 143
UnassociateDomainNode (infacmd)
description 144
UndoCheckout (pmrep)
description 265
Unregister (pmrep)
description 265
UnregisterPlugin (pmrep)
description 266
UnscheduleWorkflow (pmcmd)
description 211
UnsetFolder (pmcmd)
description 212
UpdateConnection (pmrep)
description 268
UpdateDomainOptions (infacmd)
description 145
UpdateDomainPassword (infacmd)
description 146
UpdateEmailAddr (pmrep)
description 269
UpdateFolder (infacmd)
description 147

UpdateGatewayInfo (infacmd)
description 148
UpdateGatewayNode (infasetup)
description 180
UpdateGrid (infacmd)
description 148
UpdateIntegrationService (infacmd)
description 149
UpdateLicense (infacmd)
description 151
UpdateMMService (infacmd)
description 151
UpdateNodeOptions (infacmd)
description 152
UpdateOSProfile (infacmd)
description 154
UpdateReportingService (infacmd)
description 155
UpdateRepositoryService (infacmd)
description 156
UpdateRTMService (infacmd)
description 157
UpdateSAPBWService (infacmd)
description 158
UpdateSeqGenVals (pmrep)
description 269
UpdateServiceLevel (infacmd)
description 159
UpdateServiceProcess (infacmd)
description 160
UpdateSMTPOptions (infacmd)
description 161
UpdateSrcPrefix (pmrep)
description 270
updating non-reusable sessions 271
UpdateStatistics (pmrep)
description 271
UpdateTargetPrefix (pmrep)
description 271
updating non-reusable sessions 272
UpdateWorkerNode (infasetup)
description 181
UpdateWSHubService (infacmd)
description 162
UpgradeDARepositoryContents (infacmd)
description 163
UpgradeDARepositoryUsers (infacmd)
description 164
users
adding to a group using infacmd 25
creating using infacmd 61
disabling using infacmd 69
editing using infacmd 70
enabling using infacmd 74
exporting using infacmd 75
importing using infacmd 88
listing using infacmd 91
removing from a group using infacmd 127
removing using infacmd 126

Index

301

V
Validate (pmrep)
description 272
validating objects
with pmrep 272
Version (pmcmd)
description 212
Version (pmrep)
description 274

W
wait mode
configuring using pmcmd 186
WaitTask (pmcmd)
description 212
WaitWorkflow (pmcmd)
description 214
Web Services Hub
associating a repository using infacmd 31
creating using infacmd 62
disassociating a repository using infacmd 143
updating using infacmd 162
workflow logs
fetching using infacmd 86
workflows
recovering using pmcmd syntax 200
starting from command line 206
stopping from command line 210

X
XML file
plug-in templates 261

302

Index

NOTICES
This Informatica product (the Software) includes certain drivers (the DataDirect Drivers) from DataDirect Technologies, an operating company of Progress Software Corporation (DataDirect)
which are subject to the following terms and conditions:
1. THE DATADIRECT DRIVERS ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN
ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY,
NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.

Informatica 8.6 TransformationLanguageReference
No ratings yet
Informatica 8.6 TransformationLanguageReference
228 pages
Performance Tuning Guide
No ratings yet
Performance Tuning Guide
78 pages
Data Profiling Guide: Informatica Powercenter
No ratings yet
Data Profiling Guide: Informatica Powercenter
92 pages
PC 861 RepositoryGuide
No ratings yet
PC 861 RepositoryGuide
220 pages
PC 851 DesignerGuide
No ratings yet
PC 851 DesignerGuide
454 pages
PC 851 Gettingstarted
No ratings yet
PC 851 Gettingstarted
182 pages
PC 851 CommandLineReference
100% (1)
PC 851 CommandLineReference
506 pages
PC 851 TroubleshootingGuide
0% (1)
PC 851 TroubleshootingGuide
614 pages
A Guide
No ratings yet
A Guide
666 pages
PC - 861 - Transformation Language Reference Guide
No ratings yet
PC - 861 - Transformation Language Reference Guide
369 pages
In 901 HF2 Command Reference en
No ratings yet
In 901 HF2 Command Reference en
558 pages
PC 901 Transformation Language Reference en
No ratings yet
PC 901 Transformation Language Reference en
224 pages
PWX 951 CommandReference en
No ratings yet
PWX 951 CommandReference en
152 pages
ICloud UserGuide
No ratings yet
ICloud UserGuide
321 pages
PWX 910HF6 ReferccccenceManual en
No ratings yet
PWX 910HF6 ReferccccenceManual en
347 pages
DX 910 DeveloperGuide en
No ratings yet
DX 910 DeveloperGuide en
81 pages
PC 910 Adv Work Flow Guide en
No ratings yet
PC 910 Adv Work Flow Guide en
298 pages
XML Guide: Informatica Powercenter (Version 9.1.0)
No ratings yet
XML Guide: Informatica Powercenter (Version 9.1.0)
135 pages
XML Guide: Informatica Powercenter (Version 9.1.0)
No ratings yet
XML Guide: Informatica Powercenter (Version 9.1.0)
135 pages
Power Exchange N CDC in A
No ratings yet
Power Exchange N CDC in A
228 pages
PC 910 Web Services Provider Guide en
No ratings yet
PC 910 Web Services Provider Guide en
117 pages
New Features Guide: Informatica (Version 9.1.0)
No ratings yet
New Features Guide: Informatica (Version 9.1.0)
18 pages
PC 901 Upgrade90 en
No ratings yet
PC 901 Upgrade90 en
41 pages
Getting Started: Informatica Powercenter (Version 9.1.0)
No ratings yet
Getting Started: Informatica Powercenter (Version 9.1.0)
122 pages
Getting Started: Informatica Powercenter (Version 9.1.0)
No ratings yet
Getting Started: Informatica Powercenter (Version 9.1.0)
122 pages
PDF Informatica
No ratings yet
PDF Informatica
122 pages
PC 901HF1 Upgrade90 en
No ratings yet
PC 901HF1 Upgrade90 en
43 pages
Transformation Language Reference: Informatica Powercenter (Version 9.1.0)
No ratings yet
Transformation Language Reference: Informatica Powercenter (Version 9.1.0)
213 pages
PWX 951 UtilitiesGuide en
No ratings yet
PWX 951 UtilitiesGuide en
179 pages
IN 901HF1 MessageReference PDF
No ratings yet
IN 901HF1 MessageReference PDF
455 pages
In 901HF1 MessageReference
No ratings yet
In 901HF1 MessageReference
455 pages
PC 951HF1 GettingStarted en
No ratings yet
PC 951HF1 GettingStarted en
121 pages
PCX 961 GettingStartedGuide en
No ratings yet
PCX 961 GettingStartedGuide en
66 pages
Getting Started
No ratings yet
Getting Started
124 pages
PCX 961 InstallationAndUpgradeGuide en
No ratings yet
PCX 961 InstallationAndUpgradeGuide en
65 pages
DQ 951 PC Integration UserGuide en
No ratings yet
DQ 951 PC Integration UserGuide en
23 pages
PWX 910HF2 Netezza UserGuide en
No ratings yet
PWX 910HF2 Netezza UserGuide en
28 pages
MM 910 AdministratorGuide en
No ratings yet
MM 910 AdministratorGuide en
214 pages
DP 910 IDPDeveloperGuide en
No ratings yet
DP 910 IDPDeveloperGuide en
128 pages
Installation PowerCenter Express
No ratings yet
Installation PowerCenter Express
60 pages
Python Basics for Beginners
100% (1)
Python Basics for Beginners
26 pages
Galatians Andrew Wommack
No ratings yet
Galatians Andrew Wommack
3 pages
Ephesians Study Notes
No ratings yet
Ephesians Study Notes
9 pages
Positive Parenting Tips Guide
100% (1)
Positive Parenting Tips Guide
28 pages
Ephesians Study Notes
No ratings yet
Ephesians Study Notes
9 pages
Jesus: The Cornerstone of Life
100% (4)
Jesus: The Cornerstone of Life
20 pages
India Christian Matrimony Profiles
No ratings yet
India Christian Matrimony Profiles
340 pages
Who Iam in Christ
No ratings yet
Who Iam in Christ
4 pages
Message On Salvation - 4th June'16
No ratings yet
Message On Salvation - 4th June'16
6 pages
STR 4 Tet
No ratings yet
STR 4 Tet
2 pages
58-77 Chorouses
No ratings yet
58-77 Chorouses
21 pages
PowerCenter DI 9x Dev Specialist Skill Set Inventory
No ratings yet
PowerCenter DI 9x Dev Specialist Skill Set Inventory
5 pages
Cement Industry Professional Profile
No ratings yet
Cement Industry Professional Profile
2 pages
BR 5 Tet
No ratings yet
BR 5 Tet
2 pages
Fatherhood Derek Prince
100% (7)
Fatherhood Derek Prince
43 pages
Aero-engine Load Path Visualization
No ratings yet
Aero-engine Load Path Visualization
68 pages
Concepts of Information Theory Amp Coding 2nd Ed PDF
No ratings yet
Concepts of Information Theory Amp Coding 2nd Ed PDF
2 pages
Inventory Management System (Ip Class 12)
No ratings yet
Inventory Management System (Ip Class 12)
20 pages
Beech Duke B60 FSX Setup Guide
No ratings yet
Beech Duke B60 FSX Setup Guide
37 pages
ARIEL: Brain-Computer Interfaces Meet Large Language Models For Emotional Support Conversation
No ratings yet
ARIEL: Brain-Computer Interfaces Meet Large Language Models For Emotional Support Conversation
9 pages
Rushikesh Salunkhe Resume N
No ratings yet
Rushikesh Salunkhe Resume N
1 page
Assignment on Java Supplier Class
No ratings yet
Assignment on Java Supplier Class
3 pages
Pega 8.4 Personal Edition Installation Guide
No ratings yet
Pega 8.4 Personal Edition Installation Guide
14 pages
Automatic Interlocking Table Generation
No ratings yet
Automatic Interlocking Table Generation
6 pages
Project Synopsis for B.Sc. & M.Sc. Degrees
No ratings yet
Project Synopsis for B.Sc. & M.Sc. Degrees
5 pages
How Algorithms Shape Human Thought
No ratings yet
How Algorithms Shape Human Thought
3 pages
Electronics & System Engineer CV
No ratings yet
Electronics & System Engineer CV
3 pages
Windows 10 Quick Reference
No ratings yet
Windows 10 Quick Reference
40 pages
Fast Track Solo Guide
No ratings yet
Fast Track Solo Guide
24 pages
SCADA Integration Whitepaper
No ratings yet
SCADA Integration Whitepaper
16 pages
Texas Instruments Power Management Guide
50% (2)
Texas Instruments Power Management Guide
85 pages
Digital Reef SDKLog
No ratings yet
Digital Reef SDKLog
4 pages
Uma Srinivasan - Surya Nepal - Managing Multimedia Semantics-IRM Press (2005)
No ratings yet
Uma Srinivasan - Surya Nepal - Managing Multimedia Semantics-IRM Press (2005)
428 pages
SPC Iccp
100% (1)
SPC Iccp
46 pages
QGIS Vector Styling Guide
No ratings yet
QGIS Vector Styling Guide
21 pages
MQP - Bic403-Oops With Java
No ratings yet
MQP - Bic403-Oops With Java
2 pages
Unit (4) Technical Writing
No ratings yet
Unit (4) Technical Writing
2 pages
PPS Important Questions All UNITS
No ratings yet
PPS Important Questions All UNITS
5 pages
SMART Ecological Records - v1
No ratings yet
SMART Ecological Records - v1
2 pages
Convergence in Big Data Analytics
No ratings yet
Convergence in Big Data Analytics
5 pages
Moodle Architecture for Students
No ratings yet
Moodle Architecture for Students
7 pages
Java Programming Course Outline
No ratings yet
Java Programming Course Outline
3 pages
System Software Unit 1 Exercise Solution
100% (12)
System Software Unit 1 Exercise Solution
8 pages
Sudo Apt-Get Install Macchanger Macchanger - R Eth0
No ratings yet
Sudo Apt-Get Install Macchanger Macchanger - R Eth0
14 pages
Python: A Programmer's Overview
No ratings yet
Python: A Programmer's Overview
12 pages